libZSservicesZSamazonka-mobileZSamazonka-mobile
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.Mobile.ExportProject

Description

Exports project configuration to a snapshot which can be downloaded and shared. Note that mobile app push credentials are encrypted in exported projects, so they can only be shared successfully within the same AWS account.

Synopsis

Creating a Request

data ExportProject Source #

Request structure used in requests to export project configuration details.

See: newExportProject smart constructor.

Constructors

ExportProject' 

Fields

Instances

Instances details
Eq ExportProject Source # 
Instance details

Defined in Amazonka.Mobile.ExportProject

Methods

(==) :: ExportProject -> ExportProject -> Bool #

(/=) :: ExportProject -> ExportProject -> Bool #

Read ExportProject Source # 
Instance details

Defined in Amazonka.Mobile.ExportProject

Methods

readsPrec :: Int -> ReadS ExportProject #

readList :: ReadS [ExportProject] #

readPrec :: ReadPrec ExportProject #

readListPrec :: ReadPrec [ExportProject] #

Show ExportProject Source # 
Instance details

Defined in Amazonka.Mobile.ExportProject

Methods

showsPrec :: Int -> ExportProject -> ShowS #

show :: ExportProject -> String #

showList :: [ExportProject] -> ShowS #

Generic ExportProject Source # 
Instance details

Defined in Amazonka.Mobile.ExportProject

Associated Types

type Rep ExportProject :: Type -> Type #

Methods

from :: ExportProject -> Rep ExportProject x #

to :: Rep ExportProject x -> ExportProject #

NFData ExportProject Source # 
Instance details

Defined in Amazonka.Mobile.ExportProject

Methods

rnf :: ExportProject -> () #

Hashable ExportProject Source # 
Instance details

Defined in Amazonka.Mobile.ExportProject

Methods

hashWithSalt :: Int -> ExportProject -> Int #

hash :: ExportProject -> Int #

ToJSON ExportProject Source # 
Instance details

Defined in Amazonka.Mobile.ExportProject

Methods

toJSON :: ExportProject -> Value #

toEncoding :: ExportProject -> Encoding #

toJSONList :: [ExportProject] -> Value #

toEncodingList :: [ExportProject] -> Encoding #

AWSRequest ExportProject Source # 
Instance details

Defined in Amazonka.Mobile.ExportProject

Associated Types

type AWSResponse ExportProject #

Methods

request :: ExportProject -> Request ExportProject #

response :: MonadResource m => Logger -> Service -> Proxy ExportProject -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ExportProject))) #

ToHeaders ExportProject Source # 
Instance details

Defined in Amazonka.Mobile.ExportProject

Methods

toHeaders :: ExportProject -> [Header] #

ToPath ExportProject Source # 
Instance details

Defined in Amazonka.Mobile.ExportProject

Methods

toPath :: ExportProject -> ByteString #

ToQuery ExportProject Source # 
Instance details

Defined in Amazonka.Mobile.ExportProject

Methods

toQuery :: ExportProject -> QueryString #

type Rep ExportProject Source # 
Instance details

Defined in Amazonka.Mobile.ExportProject

type Rep ExportProject = D1 ('MetaData "ExportProject" "Amazonka.Mobile.ExportProject" "libZSservicesZSamazonka-mobileZSamazonka-mobile" 'False) (C1 ('MetaCons "ExportProject'" 'PrefixI 'True) (S1 ('MetaSel ('Just "projectId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse ExportProject Source # 
Instance details

Defined in Amazonka.Mobile.ExportProject

type AWSResponse ExportProject = ExportProjectResponse

newExportProject Source #

Arguments

:: Text

$sel:projectId:ExportProject'

-> ExportProject 

Create a value of ExportProject 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:projectId:ExportProject', exportProject_projectId - Unique project identifier.

Request Lenses

exportProject_projectId :: Lens' ExportProject Text Source #

Unique project identifier.

Destructuring the Response

data ExportProjectResponse Source #

Result structure used for requests to export project configuration details.

See: newExportProjectResponse smart constructor.

Constructors

ExportProjectResponse' 

Fields

  • shareUrl :: Maybe Text

    URL which can be shared to allow other AWS users to create their own project in AWS Mobile Hub with the same configuration as the specified project. This URL pertains to a snapshot in time of the project configuration that is created when this API is called. If you want to share additional changes to your project configuration, then you will need to create and share a new snapshot by calling this method again.

  • downloadUrl :: Maybe Text

    URL which can be used to download the exported project configuation file(s).

  • snapshotId :: Maybe Text

    Unique identifier for the exported snapshot of the project configuration. This snapshot identifier is included in the share URL.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq ExportProjectResponse Source # 
Instance details

Defined in Amazonka.Mobile.ExportProject

Methods

(==) :: ExportProjectResponse -> ExportProjectResponse -> Bool #

(/=) :: ExportProjectResponse -> ExportProjectResponse -> Bool #

Read ExportProjectResponse Source # 
Instance details

Defined in Amazonka.Mobile.ExportProject

Methods

readsPrec :: Int -> ReadS ExportProjectResponse #

readList :: ReadS [ExportProjectResponse] #

readPrec :: ReadPrec ExportProjectResponse #

readListPrec :: ReadPrec [ExportProjectResponse] #

Show ExportProjectResponse Source # 
Instance details

Defined in Amazonka.Mobile.ExportProject

Methods

showsPrec :: Int -> ExportProjectResponse -> ShowS #

show :: ExportProjectResponse -> String #

showList :: [ExportProjectResponse] -> ShowS #

Generic ExportProjectResponse Source # 
Instance details

Defined in Amazonka.Mobile.ExportProject

Associated Types

type Rep ExportProjectResponse :: Type -> Type #

Methods

from :: ExportProjectResponse -> Rep ExportProjectResponse x #

to :: Rep ExportProjectResponse x -> ExportProjectResponse #

NFData ExportProjectResponse Source # 
Instance details

Defined in Amazonka.Mobile.ExportProject

Methods

rnf :: ExportProjectResponse -> () #

type Rep ExportProjectResponse Source # 
Instance details

Defined in Amazonka.Mobile.ExportProject

type Rep ExportProjectResponse = D1 ('MetaData "ExportProjectResponse" "Amazonka.Mobile.ExportProject" "libZSservicesZSamazonka-mobileZSamazonka-mobile" 'False) (C1 ('MetaCons "ExportProjectResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "shareUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "downloadUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "snapshotId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newExportProjectResponse Source #

Arguments

:: Int

$sel:httpStatus:ExportProjectResponse'

-> ExportProjectResponse 

Create a value of ExportProjectResponse 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:shareUrl:ExportProjectResponse', exportProjectResponse_shareUrl - URL which can be shared to allow other AWS users to create their own project in AWS Mobile Hub with the same configuration as the specified project. This URL pertains to a snapshot in time of the project configuration that is created when this API is called. If you want to share additional changes to your project configuration, then you will need to create and share a new snapshot by calling this method again.

$sel:downloadUrl:ExportProjectResponse', exportProjectResponse_downloadUrl - URL which can be used to download the exported project configuation file(s).

$sel:snapshotId:ExportProjectResponse', exportProjectResponse_snapshotId - Unique identifier for the exported snapshot of the project configuration. This snapshot identifier is included in the share URL.

$sel:httpStatus:ExportProjectResponse', exportProjectResponse_httpStatus - The response's http status code.

Response Lenses

exportProjectResponse_shareUrl :: Lens' ExportProjectResponse (Maybe Text) Source #

URL which can be shared to allow other AWS users to create their own project in AWS Mobile Hub with the same configuration as the specified project. This URL pertains to a snapshot in time of the project configuration that is created when this API is called. If you want to share additional changes to your project configuration, then you will need to create and share a new snapshot by calling this method again.

exportProjectResponse_downloadUrl :: Lens' ExportProjectResponse (Maybe Text) Source #

URL which can be used to download the exported project configuation file(s).

exportProjectResponse_snapshotId :: Lens' ExportProjectResponse (Maybe Text) Source #

Unique identifier for the exported snapshot of the project configuration. This snapshot identifier is included in the share URL.

exportProjectResponse_httpStatus :: Lens' ExportProjectResponse Int Source #

The response's http status code.