libZSservicesZSamazonka-signerZSamazonka-signer
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Signer.ListSigningProfiles

Description

Lists all available signing profiles in your AWS account. Returns only profiles with an ACTIVE status unless the includeCanceled request field is set to true. If additional jobs remain to be listed, code signing returns a nextToken value. Use this value in subsequent calls to ListSigningJobs to fetch the remaining values. You can continue calling ListSigningJobs with your maxResults parameter and with new values that code signing returns in the nextToken parameter until all of your signing jobs have been returned.

This operation returns paginated results.

Synopsis

Creating a Request

data ListSigningProfiles Source #

See: newListSigningProfiles smart constructor.

Constructors

ListSigningProfiles' 

Fields

  • nextToken :: Maybe Text

    Value for specifying the next set of paginated results to return. After you receive a response with truncated results, use this parameter in a subsequent request. Set it to the value of nextToken from the response that you just received.

  • platformId :: Maybe Text

    Filters results to return only signing jobs initiated for a specified signing platform.

  • statuses :: Maybe [SigningProfileStatus]

    Filters results to return only signing jobs with statuses in the specified list.

  • includeCanceled :: Maybe Bool

    Designates whether to include profiles with the status of CANCELED.

  • maxResults :: Maybe Natural

    The maximum number of profiles to be returned.

Instances

Instances details
Eq ListSigningProfiles Source # 
Instance details

Defined in Amazonka.Signer.ListSigningProfiles

Read ListSigningProfiles Source # 
Instance details

Defined in Amazonka.Signer.ListSigningProfiles

Show ListSigningProfiles Source # 
Instance details

Defined in Amazonka.Signer.ListSigningProfiles

Generic ListSigningProfiles Source # 
Instance details

Defined in Amazonka.Signer.ListSigningProfiles

Associated Types

type Rep ListSigningProfiles :: Type -> Type #

NFData ListSigningProfiles Source # 
Instance details

Defined in Amazonka.Signer.ListSigningProfiles

Methods

rnf :: ListSigningProfiles -> () #

Hashable ListSigningProfiles Source # 
Instance details

Defined in Amazonka.Signer.ListSigningProfiles

AWSPager ListSigningProfiles Source # 
Instance details

Defined in Amazonka.Signer.ListSigningProfiles

AWSRequest ListSigningProfiles Source # 
Instance details

Defined in Amazonka.Signer.ListSigningProfiles

Associated Types

type AWSResponse ListSigningProfiles #

ToHeaders ListSigningProfiles Source # 
Instance details

Defined in Amazonka.Signer.ListSigningProfiles

ToPath ListSigningProfiles Source # 
Instance details

Defined in Amazonka.Signer.ListSigningProfiles

ToQuery ListSigningProfiles Source # 
Instance details

Defined in Amazonka.Signer.ListSigningProfiles

type Rep ListSigningProfiles Source # 
Instance details

Defined in Amazonka.Signer.ListSigningProfiles

type Rep ListSigningProfiles = D1 ('MetaData "ListSigningProfiles" "Amazonka.Signer.ListSigningProfiles" "libZSservicesZSamazonka-signerZSamazonka-signer" 'False) (C1 ('MetaCons "ListSigningProfiles'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "platformId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "statuses") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SigningProfileStatus])) :*: (S1 ('MetaSel ('Just "includeCanceled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))))
type AWSResponse ListSigningProfiles Source # 
Instance details

Defined in Amazonka.Signer.ListSigningProfiles

newListSigningProfiles :: ListSigningProfiles Source #

Create a value of ListSigningProfiles 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:nextToken:ListSigningProfiles', listSigningProfiles_nextToken - Value for specifying the next set of paginated results to return. After you receive a response with truncated results, use this parameter in a subsequent request. Set it to the value of nextToken from the response that you just received.

$sel:platformId:ListSigningProfiles', listSigningProfiles_platformId - Filters results to return only signing jobs initiated for a specified signing platform.

$sel:statuses:ListSigningProfiles', listSigningProfiles_statuses - Filters results to return only signing jobs with statuses in the specified list.

$sel:includeCanceled:ListSigningProfiles', listSigningProfiles_includeCanceled - Designates whether to include profiles with the status of CANCELED.

$sel:maxResults:ListSigningProfiles', listSigningProfiles_maxResults - The maximum number of profiles to be returned.

Request Lenses

listSigningProfiles_nextToken :: Lens' ListSigningProfiles (Maybe Text) Source #

Value for specifying the next set of paginated results to return. After you receive a response with truncated results, use this parameter in a subsequent request. Set it to the value of nextToken from the response that you just received.

listSigningProfiles_platformId :: Lens' ListSigningProfiles (Maybe Text) Source #

Filters results to return only signing jobs initiated for a specified signing platform.

listSigningProfiles_statuses :: Lens' ListSigningProfiles (Maybe [SigningProfileStatus]) Source #

Filters results to return only signing jobs with statuses in the specified list.

listSigningProfiles_includeCanceled :: Lens' ListSigningProfiles (Maybe Bool) Source #

Designates whether to include profiles with the status of CANCELED.

listSigningProfiles_maxResults :: Lens' ListSigningProfiles (Maybe Natural) Source #

The maximum number of profiles to be returned.

Destructuring the Response

data ListSigningProfilesResponse Source #

See: newListSigningProfilesResponse smart constructor.

Constructors

ListSigningProfilesResponse' 

Fields

  • profiles :: Maybe [SigningProfile]

    A list of profiles that are available in the AWS account. This includes profiles with the status of CANCELED if the includeCanceled parameter is set to true.

  • nextToken :: Maybe Text

    Value for specifying the next set of paginated results to return.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq ListSigningProfilesResponse Source # 
Instance details

Defined in Amazonka.Signer.ListSigningProfiles

Read ListSigningProfilesResponse Source # 
Instance details

Defined in Amazonka.Signer.ListSigningProfiles

Show ListSigningProfilesResponse Source # 
Instance details

Defined in Amazonka.Signer.ListSigningProfiles

Generic ListSigningProfilesResponse Source # 
Instance details

Defined in Amazonka.Signer.ListSigningProfiles

Associated Types

type Rep ListSigningProfilesResponse :: Type -> Type #

NFData ListSigningProfilesResponse Source # 
Instance details

Defined in Amazonka.Signer.ListSigningProfiles

type Rep ListSigningProfilesResponse Source # 
Instance details

Defined in Amazonka.Signer.ListSigningProfiles

type Rep ListSigningProfilesResponse = D1 ('MetaData "ListSigningProfilesResponse" "Amazonka.Signer.ListSigningProfiles" "libZSservicesZSamazonka-signerZSamazonka-signer" 'False) (C1 ('MetaCons "ListSigningProfilesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "profiles") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SigningProfile])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListSigningProfilesResponse Source #

Create a value of ListSigningProfilesResponse 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:profiles:ListSigningProfilesResponse', listSigningProfilesResponse_profiles - A list of profiles that are available in the AWS account. This includes profiles with the status of CANCELED if the includeCanceled parameter is set to true.

$sel:nextToken:ListSigningProfiles', listSigningProfilesResponse_nextToken - Value for specifying the next set of paginated results to return.

$sel:httpStatus:ListSigningProfilesResponse', listSigningProfilesResponse_httpStatus - The response's http status code.

Response Lenses

listSigningProfilesResponse_profiles :: Lens' ListSigningProfilesResponse (Maybe [SigningProfile]) Source #

A list of profiles that are available in the AWS account. This includes profiles with the status of CANCELED if the includeCanceled parameter is set to true.

listSigningProfilesResponse_nextToken :: Lens' ListSigningProfilesResponse (Maybe Text) Source #

Value for specifying the next set of paginated results to return.