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.CodeCommit.UpdateRepositoryDescription

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Sets or changes the comment or description for a repository.

The description field for a repository accepts all HTML characters and all valid Unicode characters. Applications that do not HTML-encode the description and display it in a webpage can expose users to potentially malicious code. Make sure that you HTML-encode the description field in any application that uses this API to display the repository description on a webpage.

Creating a Request

data UpdateRepositoryDescription Source #

Represents the input of an update repository description operation.

See: newUpdateRepositoryDescription smart constructor.

Constructors

UpdateRepositoryDescription'
Fields repositoryDescription :: Maybe Text The new comment or description for the specified repository. Repository descriptions are limited to 1,000 characters. repositoryName :: Text The name of the repository to set or change the comment or description for.

Instances

Instances details

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

newUpdateRepositoryDescription Source #

Arguments

:: Text	`UpdateRepositoryDescription`
-> UpdateRepositoryDescription

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

UpdateRepositoryDescription, updateRepositoryDescription_repositoryDescription - The new comment or description for the specified repository. Repository descriptions are limited to 1,000 characters.

UpdateRepositoryDescription, updateRepositoryDescription_repositoryName - The name of the repository to set or change the comment or description for.

Request Lenses

updateRepositoryDescription_repositoryDescription :: Lens' UpdateRepositoryDescription (Maybe Text) Source #

The new comment or description for the specified repository. Repository descriptions are limited to 1,000 characters.

updateRepositoryDescription_repositoryName :: Lens' UpdateRepositoryDescription Text Source #

The name of the repository to set or change the comment or description for.

Destructuring the Response

data UpdateRepositoryDescriptionResponse Source #

See: newUpdateRepositoryDescriptionResponse smart constructor.

Constructors

UpdateRepositoryDescriptionResponse'

Instances

Instances details

Generic UpdateRepositoryDescriptionResponse Source #
Instance details Defined in Amazonka.CodeCommit.UpdateRepositoryDescription Associated Types type Rep UpdateRepositoryDescriptionResponse :: Type -> Type # Methods from :: UpdateRepositoryDescriptionResponse -> Rep UpdateRepositoryDescriptionResponse x # to :: Rep UpdateRepositoryDescriptionResponse x -> UpdateRepositoryDescriptionResponse #
Read UpdateRepositoryDescriptionResponse Source #
Instance details Defined in Amazonka.CodeCommit.UpdateRepositoryDescription Methods readsPrec :: Int -> ReadS UpdateRepositoryDescriptionResponse # readList :: ReadS [UpdateRepositoryDescriptionResponse] # readPrec :: ReadPrec UpdateRepositoryDescriptionResponse # readListPrec :: ReadPrec [UpdateRepositoryDescriptionResponse] #
Show UpdateRepositoryDescriptionResponse Source #
Instance details Defined in Amazonka.CodeCommit.UpdateRepositoryDescription Methods showsPrec :: Int -> UpdateRepositoryDescriptionResponse -> ShowS # show :: UpdateRepositoryDescriptionResponse -> String # showList :: [UpdateRepositoryDescriptionResponse] -> ShowS #
NFData UpdateRepositoryDescriptionResponse Source #
Instance details Defined in Amazonka.CodeCommit.UpdateRepositoryDescription Methods rnf :: UpdateRepositoryDescriptionResponse -> () #
Eq UpdateRepositoryDescriptionResponse Source #
Instance details Defined in Amazonka.CodeCommit.UpdateRepositoryDescription Methods (==) :: UpdateRepositoryDescriptionResponse -> UpdateRepositoryDescriptionResponse -> Bool # (/=) :: UpdateRepositoryDescriptionResponse -> UpdateRepositoryDescriptionResponse -> Bool #
type Rep UpdateRepositoryDescriptionResponse Source #
Instance details Defined in Amazonka.CodeCommit.UpdateRepositoryDescription type Rep UpdateRepositoryDescriptionResponse = D1 ('MetaData "UpdateRepositoryDescriptionResponse" "Amazonka.CodeCommit.UpdateRepositoryDescription" "amazonka-codecommit-2.0-974g5LOhuTPG9HgUSx02zG" 'False) (C1 ('MetaCons "UpdateRepositoryDescriptionResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newUpdateRepositoryDescriptionResponse :: UpdateRepositoryDescriptionResponse Source #

Create a value of UpdateRepositoryDescriptionResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.