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.GameLift.RequestUploadCredentials

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves a fresh set of credentials for use when uploading a new set of game build files to Amazon GameLift's Amazon S3. This is done as part of the build creation process; see GameSession.

To request new credentials, specify the build ID as returned with an initial CreateBuild request. If successful, a new set of credentials are returned, along with the S3 storage location associated with the build ID.

Learn more

Create a Build with Files in S3

All APIs by task

Creating a Request

data RequestUploadCredentials Source #

See: newRequestUploadCredentials smart constructor.

Constructors

RequestUploadCredentials'
Fields buildId :: Text A unique identifier for the build to get credentials for. You can use either the build ID or ARN value.

Instances

Instances details

ToJSON RequestUploadCredentials Source #
Instance details Defined in Amazonka.GameLift.RequestUploadCredentials Methods toJSON :: RequestUploadCredentials -> Value # toEncoding :: RequestUploadCredentials -> Encoding # toJSONList :: [RequestUploadCredentials] -> Value # toEncodingList :: [RequestUploadCredentials] -> Encoding #
ToHeaders RequestUploadCredentials Source #
Instance details Defined in Amazonka.GameLift.RequestUploadCredentials Methods toHeaders :: RequestUploadCredentials -> [Header] #
ToPath RequestUploadCredentials Source #
Instance details Defined in Amazonka.GameLift.RequestUploadCredentials Methods toPath :: RequestUploadCredentials -> ByteString #
ToQuery RequestUploadCredentials Source #
Instance details Defined in Amazonka.GameLift.RequestUploadCredentials Methods toQuery :: RequestUploadCredentials -> QueryString #
AWSRequest RequestUploadCredentials Source #
Instance details Defined in Amazonka.GameLift.RequestUploadCredentials Associated Types type AWSResponse RequestUploadCredentials # Methods request :: (Service -> Service) -> RequestUploadCredentials -> Request RequestUploadCredentials # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy RequestUploadCredentials -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse RequestUploadCredentials))) #
Generic RequestUploadCredentials Source #
Instance details Defined in Amazonka.GameLift.RequestUploadCredentials Associated Types type Rep RequestUploadCredentials :: Type -> Type # Methods from :: RequestUploadCredentials -> Rep RequestUploadCredentials x # to :: Rep RequestUploadCredentials x -> RequestUploadCredentials #
Read RequestUploadCredentials Source #
Instance details Defined in Amazonka.GameLift.RequestUploadCredentials Methods readsPrec :: Int -> ReadS RequestUploadCredentials # readList :: ReadS [RequestUploadCredentials] # readPrec :: ReadPrec RequestUploadCredentials # readListPrec :: ReadPrec [RequestUploadCredentials] #
Show RequestUploadCredentials Source #
Instance details Defined in Amazonka.GameLift.RequestUploadCredentials Methods showsPrec :: Int -> RequestUploadCredentials -> ShowS # show :: RequestUploadCredentials -> String # showList :: [RequestUploadCredentials] -> ShowS #
NFData RequestUploadCredentials Source #
Instance details Defined in Amazonka.GameLift.RequestUploadCredentials Methods rnf :: RequestUploadCredentials -> () #
Eq RequestUploadCredentials Source #
Instance details Defined in Amazonka.GameLift.RequestUploadCredentials Methods (==) :: RequestUploadCredentials -> RequestUploadCredentials -> Bool # (/=) :: RequestUploadCredentials -> RequestUploadCredentials -> Bool #
Hashable RequestUploadCredentials Source #
Instance details Defined in Amazonka.GameLift.RequestUploadCredentials Methods hashWithSalt :: Int -> RequestUploadCredentials -> Int # hash :: RequestUploadCredentials -> Int #
type AWSResponse RequestUploadCredentials Source #
Instance details Defined in Amazonka.GameLift.RequestUploadCredentials type AWSResponse RequestUploadCredentials = RequestUploadCredentialsResponse
type Rep RequestUploadCredentials Source #
Instance details Defined in Amazonka.GameLift.RequestUploadCredentials type Rep RequestUploadCredentials = D1 ('MetaData "RequestUploadCredentials" "Amazonka.GameLift.RequestUploadCredentials" "amazonka-gamelift-2.0-IjhNQby9jLV6gj30IrgsyK" 'False) (C1 ('MetaCons "RequestUploadCredentials'" 'PrefixI 'True) (S1 ('MetaSel ('Just "buildId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newRequestUploadCredentials Source #

Arguments

:: Text	`RequestUploadCredentials`
-> RequestUploadCredentials

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

RequestUploadCredentials, requestUploadCredentials_buildId - A unique identifier for the build to get credentials for. You can use either the build ID or ARN value.

Request Lenses

requestUploadCredentials_buildId :: Lens' RequestUploadCredentials Text Source #

A unique identifier for the build to get credentials for. You can use either the build ID or ARN value.

Destructuring the Response

data RequestUploadCredentialsResponse Source #

See: newRequestUploadCredentialsResponse smart constructor.

Constructors

RequestUploadCredentialsResponse'

Fields

storageLocation :: Maybe S3Location
Amazon S3 path and key, identifying where the game build files are stored.
uploadCredentials :: Maybe (Sensitive AwsCredentials)
Amazon Web Services credentials required when uploading a game build to the storage location. These credentials have a limited lifespan and are valid only for the build they were issued for.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic RequestUploadCredentialsResponse Source #
Instance details Defined in Amazonka.GameLift.RequestUploadCredentials Associated Types type Rep RequestUploadCredentialsResponse :: Type -> Type # Methods from :: RequestUploadCredentialsResponse -> Rep RequestUploadCredentialsResponse x # to :: Rep RequestUploadCredentialsResponse x -> RequestUploadCredentialsResponse #
Show RequestUploadCredentialsResponse Source #
Instance details Defined in Amazonka.GameLift.RequestUploadCredentials Methods showsPrec :: Int -> RequestUploadCredentialsResponse -> ShowS # show :: RequestUploadCredentialsResponse -> String # showList :: [RequestUploadCredentialsResponse] -> ShowS #
NFData RequestUploadCredentialsResponse Source #
Instance details Defined in Amazonka.GameLift.RequestUploadCredentials Methods rnf :: RequestUploadCredentialsResponse -> () #
Eq RequestUploadCredentialsResponse Source #
Instance details Defined in Amazonka.GameLift.RequestUploadCredentials Methods (==) :: RequestUploadCredentialsResponse -> RequestUploadCredentialsResponse -> Bool # (/=) :: RequestUploadCredentialsResponse -> RequestUploadCredentialsResponse -> Bool #
type Rep RequestUploadCredentialsResponse Source #
Instance details Defined in Amazonka.GameLift.RequestUploadCredentials type Rep RequestUploadCredentialsResponse = D1 ('MetaData "RequestUploadCredentialsResponse" "Amazonka.GameLift.RequestUploadCredentials" "amazonka-gamelift-2.0-IjhNQby9jLV6gj30IrgsyK" 'False) (C1 ('MetaCons "RequestUploadCredentialsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "storageLocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe S3Location)) :: (S1 ('MetaSel ('Just "uploadCredentials") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive AwsCredentials))) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newRequestUploadCredentialsResponse Source #

Arguments

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

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

RequestUploadCredentialsResponse, requestUploadCredentialsResponse_storageLocation - Amazon S3 path and key, identifying where the game build files are stored.

$sel:uploadCredentials:RequestUploadCredentialsResponse', requestUploadCredentialsResponse_uploadCredentials - Amazon Web Services credentials required when uploading a game build to the storage location. These credentials have a limited lifespan and are valid only for the build they were issued for.

$sel:httpStatus:RequestUploadCredentialsResponse', requestUploadCredentialsResponse_httpStatus - The response's http status code.

Response Lenses

requestUploadCredentialsResponse_storageLocation :: Lens' RequestUploadCredentialsResponse (Maybe S3Location) Source #

Amazon S3 path and key, identifying where the game build files are stored.

requestUploadCredentialsResponse_uploadCredentials :: Lens' RequestUploadCredentialsResponse (Maybe AwsCredentials) Source #

Amazon Web Services credentials required when uploading a game build to the storage location. These credentials have a limited lifespan and are valid only for the build they were issued for.

requestUploadCredentialsResponse_httpStatus :: Lens' RequestUploadCredentialsResponse Int Source #

The response's http status code.