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.Connect.SearchSecurityProfiles

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

This API is in preview release for Amazon Connect and is subject to change.

Searches security profiles in an Amazon Connect instance, with optional filtering.

This operation returns paginated results.

Synopsis

Creating a Request

data SearchSecurityProfiles Source #

See: newSearchSecurityProfiles smart constructor.

Constructors

SearchSecurityProfiles'

Fields

maxResults :: Maybe Natural
The maximum number of results to return per page.
nextToken :: Maybe Text
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
searchCriteria :: Maybe SecurityProfileSearchCriteria
The search criteria to be used to return security profiles.
The name field support "contains" queries with a minimum of 2 characters and maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results.
The currently supported value for FieldName: name
searchFilter :: Maybe SecurityProfilesSearchFilter
Filters to be applied to search results.
instanceId :: Text
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Instances

Instances details

ToJSON SearchSecurityProfiles Source #
Instance details Defined in Amazonka.Connect.SearchSecurityProfiles Methods toJSON :: SearchSecurityProfiles -> Value # toEncoding :: SearchSecurityProfiles -> Encoding # toJSONList :: [SearchSecurityProfiles] -> Value # toEncodingList :: [SearchSecurityProfiles] -> Encoding #
ToHeaders SearchSecurityProfiles Source #
Instance details Defined in Amazonka.Connect.SearchSecurityProfiles Methods toHeaders :: SearchSecurityProfiles -> [Header] #
ToPath SearchSecurityProfiles Source #
Instance details Defined in Amazonka.Connect.SearchSecurityProfiles Methods toPath :: SearchSecurityProfiles -> ByteString #
ToQuery SearchSecurityProfiles Source #
Instance details Defined in Amazonka.Connect.SearchSecurityProfiles Methods toQuery :: SearchSecurityProfiles -> QueryString #
AWSPager SearchSecurityProfiles Source #
Instance details Defined in Amazonka.Connect.SearchSecurityProfiles Methods page :: SearchSecurityProfiles -> AWSResponse SearchSecurityProfiles -> Maybe SearchSecurityProfiles #
AWSRequest SearchSecurityProfiles Source #
Instance details Defined in Amazonka.Connect.SearchSecurityProfiles Associated Types type AWSResponse SearchSecurityProfiles # Methods request :: (Service -> Service) -> SearchSecurityProfiles -> Request SearchSecurityProfiles # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy SearchSecurityProfiles -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse SearchSecurityProfiles))) #
Generic SearchSecurityProfiles Source #
Instance details Defined in Amazonka.Connect.SearchSecurityProfiles Associated Types type Rep SearchSecurityProfiles :: Type -> Type # Methods from :: SearchSecurityProfiles -> Rep SearchSecurityProfiles x # to :: Rep SearchSecurityProfiles x -> SearchSecurityProfiles #
Read SearchSecurityProfiles Source #
Instance details Defined in Amazonka.Connect.SearchSecurityProfiles Methods readsPrec :: Int -> ReadS SearchSecurityProfiles # readList :: ReadS [SearchSecurityProfiles] # readPrec :: ReadPrec SearchSecurityProfiles # readListPrec :: ReadPrec [SearchSecurityProfiles] #
Show SearchSecurityProfiles Source #
Instance details Defined in Amazonka.Connect.SearchSecurityProfiles Methods showsPrec :: Int -> SearchSecurityProfiles -> ShowS # show :: SearchSecurityProfiles -> String # showList :: [SearchSecurityProfiles] -> ShowS #
NFData SearchSecurityProfiles Source #
Instance details Defined in Amazonka.Connect.SearchSecurityProfiles Methods rnf :: SearchSecurityProfiles -> () #
Eq SearchSecurityProfiles Source #
Instance details Defined in Amazonka.Connect.SearchSecurityProfiles Methods (==) :: SearchSecurityProfiles -> SearchSecurityProfiles -> Bool # (/=) :: SearchSecurityProfiles -> SearchSecurityProfiles -> Bool #
Hashable SearchSecurityProfiles Source #
Instance details Defined in Amazonka.Connect.SearchSecurityProfiles Methods hashWithSalt :: Int -> SearchSecurityProfiles -> Int # hash :: SearchSecurityProfiles -> Int #
type AWSResponse SearchSecurityProfiles Source #
Instance details Defined in Amazonka.Connect.SearchSecurityProfiles type AWSResponse SearchSecurityProfiles = SearchSecurityProfilesResponse
type Rep SearchSecurityProfiles Source #
Instance details Defined in Amazonka.Connect.SearchSecurityProfiles type Rep SearchSecurityProfiles = D1 ('MetaData "SearchSecurityProfiles" "Amazonka.Connect.SearchSecurityProfiles" "amazonka-connect-2.0-IAACrecRcUS5AABe9BOFyN" 'False) (C1 ('MetaCons "SearchSecurityProfiles'" '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 "searchCriteria") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SecurityProfileSearchCriteria)) :: (S1 ('MetaSel ('Just "searchFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SecurityProfilesSearchFilter)) :: S1 ('MetaSel ('Just "instanceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newSearchSecurityProfiles Source #

Arguments

:: Text	`SearchSecurityProfiles`
-> SearchSecurityProfiles

Create a value of SearchSecurityProfiles 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:SearchSecurityProfiles', searchSecurityProfiles_maxResults - The maximum number of results to return per page.

SearchSecurityProfiles, searchSecurityProfiles_nextToken - The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

$sel:searchCriteria:SearchSecurityProfiles', searchSecurityProfiles_searchCriteria - The search criteria to be used to return security profiles.

The name field support "contains" queries with a minimum of 2 characters and maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results.

The currently supported value for FieldName: name

$sel:searchFilter:SearchSecurityProfiles', searchSecurityProfiles_searchFilter - Filters to be applied to search results.

SearchSecurityProfiles, searchSecurityProfiles_instanceId - The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Request Lenses

searchSecurityProfiles_maxResults :: Lens' SearchSecurityProfiles (Maybe Natural) Source #

The maximum number of results to return per page.

searchSecurityProfiles_nextToken :: Lens' SearchSecurityProfiles (Maybe Text) Source #

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

searchSecurityProfiles_searchCriteria :: Lens' SearchSecurityProfiles (Maybe SecurityProfileSearchCriteria) Source #

The search criteria to be used to return security profiles.

The name field support "contains" queries with a minimum of 2 characters and maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results.

The currently supported value for FieldName: name

searchSecurityProfiles_searchFilter :: Lens' SearchSecurityProfiles (Maybe SecurityProfilesSearchFilter) Source #

Filters to be applied to search results.

searchSecurityProfiles_instanceId :: Lens' SearchSecurityProfiles Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Destructuring the Response

data SearchSecurityProfilesResponse Source #

See: newSearchSecurityProfilesResponse smart constructor.

Constructors

SearchSecurityProfilesResponse'
Fields approximateTotalCount :: Maybe Integer The total number of security profiles which matched your search query. nextToken :: Maybe Text If there are additional results, this is the token for the next set of results. securityProfiles :: Maybe [SecurityProfileSearchSummary] Information about the security profiles. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic SearchSecurityProfilesResponse Source #
Instance details Defined in Amazonka.Connect.SearchSecurityProfiles Associated Types type Rep SearchSecurityProfilesResponse :: Type -> Type # Methods from :: SearchSecurityProfilesResponse -> Rep SearchSecurityProfilesResponse x # to :: Rep SearchSecurityProfilesResponse x -> SearchSecurityProfilesResponse #
Read SearchSecurityProfilesResponse Source #
Instance details Defined in Amazonka.Connect.SearchSecurityProfiles Methods readsPrec :: Int -> ReadS SearchSecurityProfilesResponse # readList :: ReadS [SearchSecurityProfilesResponse] # readPrec :: ReadPrec SearchSecurityProfilesResponse # readListPrec :: ReadPrec [SearchSecurityProfilesResponse] #
Show SearchSecurityProfilesResponse Source #
Instance details Defined in Amazonka.Connect.SearchSecurityProfiles Methods showsPrec :: Int -> SearchSecurityProfilesResponse -> ShowS # show :: SearchSecurityProfilesResponse -> String # showList :: [SearchSecurityProfilesResponse] -> ShowS #
NFData SearchSecurityProfilesResponse Source #
Instance details Defined in Amazonka.Connect.SearchSecurityProfiles Methods rnf :: SearchSecurityProfilesResponse -> () #
Eq SearchSecurityProfilesResponse Source #
Instance details Defined in Amazonka.Connect.SearchSecurityProfiles Methods (==) :: SearchSecurityProfilesResponse -> SearchSecurityProfilesResponse -> Bool # (/=) :: SearchSecurityProfilesResponse -> SearchSecurityProfilesResponse -> Bool #
type Rep SearchSecurityProfilesResponse Source #
Instance details Defined in Amazonka.Connect.SearchSecurityProfiles type Rep SearchSecurityProfilesResponse = D1 ('MetaData "SearchSecurityProfilesResponse" "Amazonka.Connect.SearchSecurityProfiles" "amazonka-connect-2.0-IAACrecRcUS5AABe9BOFyN" 'False) (C1 ('MetaCons "SearchSecurityProfilesResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "approximateTotalCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "securityProfiles") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SecurityProfileSearchSummary])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newSearchSecurityProfilesResponse Source #

Arguments

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

Create a value of SearchSecurityProfilesResponse 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:approximateTotalCount:SearchSecurityProfilesResponse', searchSecurityProfilesResponse_approximateTotalCount - The total number of security profiles which matched your search query.

SearchSecurityProfiles, searchSecurityProfilesResponse_nextToken - If there are additional results, this is the token for the next set of results.

$sel:securityProfiles:SearchSecurityProfilesResponse', searchSecurityProfilesResponse_securityProfiles - Information about the security profiles.

$sel:httpStatus:SearchSecurityProfilesResponse', searchSecurityProfilesResponse_httpStatus - The response's http status code.

Response Lenses

searchSecurityProfilesResponse_approximateTotalCount :: Lens' SearchSecurityProfilesResponse (Maybe Integer) Source #

The total number of security profiles which matched your search query.

searchSecurityProfilesResponse_nextToken :: Lens' SearchSecurityProfilesResponse (Maybe Text) Source #

If there are additional results, this is the token for the next set of results.

searchSecurityProfilesResponse_securityProfiles :: Lens' SearchSecurityProfilesResponse (Maybe [SecurityProfileSearchSummary]) Source #

Information about the security profiles.

searchSecurityProfilesResponse_httpStatus :: Lens' SearchSecurityProfilesResponse Int Source #

The response's http status code.