amazonka-alexa-business-2.0: Amazon Alexa For Business SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.AlexaBusiness.ListSkills

Description

Lists all enabled skills in a specific skill group.

This operation returns paginated results.

Synopsis

Creating a Request

data ListSkills Source #

See: newListSkills smart constructor.

Constructors

ListSkills' 

Fields

  • enablementType :: Maybe EnablementTypeFilter

    Whether the skill is enabled under the user's account.

  • maxResults :: Maybe Natural

    The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

  • nextToken :: Maybe Text

    An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

  • skillGroupArn :: Maybe Text

    The ARN of the skill group for which to list enabled skills.

  • skillType :: Maybe SkillTypeFilter

    Whether the skill is publicly available or is a private skill.

Instances

Instances details
ToJSON ListSkills Source # 
Instance details

Defined in Amazonka.AlexaBusiness.ListSkills

ToHeaders ListSkills Source # 
Instance details

Defined in Amazonka.AlexaBusiness.ListSkills

Methods

toHeaders :: ListSkills -> [Header] #

ToPath ListSkills Source # 
Instance details

Defined in Amazonka.AlexaBusiness.ListSkills

ToQuery ListSkills Source # 
Instance details

Defined in Amazonka.AlexaBusiness.ListSkills

AWSPager ListSkills Source # 
Instance details

Defined in Amazonka.AlexaBusiness.ListSkills

AWSRequest ListSkills Source # 
Instance details

Defined in Amazonka.AlexaBusiness.ListSkills

Associated Types

type AWSResponse ListSkills #

Generic ListSkills Source # 
Instance details

Defined in Amazonka.AlexaBusiness.ListSkills

Associated Types

type Rep ListSkills :: Type -> Type #

Read ListSkills Source # 
Instance details

Defined in Amazonka.AlexaBusiness.ListSkills

Show ListSkills Source # 
Instance details

Defined in Amazonka.AlexaBusiness.ListSkills

NFData ListSkills Source # 
Instance details

Defined in Amazonka.AlexaBusiness.ListSkills

Methods

rnf :: ListSkills -> () #

Eq ListSkills Source # 
Instance details

Defined in Amazonka.AlexaBusiness.ListSkills

Hashable ListSkills Source # 
Instance details

Defined in Amazonka.AlexaBusiness.ListSkills

type AWSResponse ListSkills Source # 
Instance details

Defined in Amazonka.AlexaBusiness.ListSkills

type Rep ListSkills Source # 
Instance details

Defined in Amazonka.AlexaBusiness.ListSkills

type Rep ListSkills = D1 ('MetaData "ListSkills" "Amazonka.AlexaBusiness.ListSkills" "amazonka-alexa-business-2.0-BWvKfxFukoyBarGovAkdOS" 'False) (C1 ('MetaCons "ListSkills'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "enablementType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EnablementTypeFilter)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "skillGroupArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "skillType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SkillTypeFilter))))))

newListSkills :: ListSkills Source #

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

ListSkills, listSkills_enablementType - Whether the skill is enabled under the user's account.

$sel:maxResults:ListSkills', listSkills_maxResults - The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

ListSkills, listSkills_nextToken - An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

ListSkills, listSkills_skillGroupArn - The ARN of the skill group for which to list enabled skills.

ListSkills, listSkills_skillType - Whether the skill is publicly available or is a private skill.

Request Lenses

listSkills_enablementType :: Lens' ListSkills (Maybe EnablementTypeFilter) Source #

Whether the skill is enabled under the user's account.

listSkills_maxResults :: Lens' ListSkills (Maybe Natural) Source #

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

listSkills_nextToken :: Lens' ListSkills (Maybe Text) Source #

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

listSkills_skillGroupArn :: Lens' ListSkills (Maybe Text) Source #

The ARN of the skill group for which to list enabled skills.

listSkills_skillType :: Lens' ListSkills (Maybe SkillTypeFilter) Source #

Whether the skill is publicly available or is a private skill.

Destructuring the Response

data ListSkillsResponse Source #

See: newListSkillsResponse smart constructor.

Constructors

ListSkillsResponse' 

Fields

Instances

Instances details
Generic ListSkillsResponse Source # 
Instance details

Defined in Amazonka.AlexaBusiness.ListSkills

Associated Types

type Rep ListSkillsResponse :: Type -> Type #

Read ListSkillsResponse Source # 
Instance details

Defined in Amazonka.AlexaBusiness.ListSkills

Show ListSkillsResponse Source # 
Instance details

Defined in Amazonka.AlexaBusiness.ListSkills

NFData ListSkillsResponse Source # 
Instance details

Defined in Amazonka.AlexaBusiness.ListSkills

Methods

rnf :: ListSkillsResponse -> () #

Eq ListSkillsResponse Source # 
Instance details

Defined in Amazonka.AlexaBusiness.ListSkills

type Rep ListSkillsResponse Source # 
Instance details

Defined in Amazonka.AlexaBusiness.ListSkills

type Rep ListSkillsResponse = D1 ('MetaData "ListSkillsResponse" "Amazonka.AlexaBusiness.ListSkills" "amazonka-alexa-business-2.0-BWvKfxFukoyBarGovAkdOS" 'False) (C1 ('MetaCons "ListSkillsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "skillSummaries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SkillSummary])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListSkillsResponse Source #

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

ListSkills, listSkillsResponse_nextToken - The token returned to indicate that there is more data available.

$sel:skillSummaries:ListSkillsResponse', listSkillsResponse_skillSummaries - The list of enabled skills requested. Required.

$sel:httpStatus:ListSkillsResponse', listSkillsResponse_httpStatus - The response's http status code.

Response Lenses

listSkillsResponse_nextToken :: Lens' ListSkillsResponse (Maybe Text) Source #

The token returned to indicate that there is more data available.

listSkillsResponse_skillSummaries :: Lens' ListSkillsResponse (Maybe [SkillSummary]) Source #

The list of enabled skills requested. Required.