Amazonka.CodeCommit.BatchGetRepositories

Returns information about one or more repositories.

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 BatchGetRepositories

Represents the input of a batch get repositories operation.

See: newBatchGetRepositories smart constructor.

Constructors

BatchGetRepositories'

Fields

• repositoryNames :: [Text]

  The names of the repositories to get information about.

  The length constraint limit is for each string in the array. The array itself can be empty.

Instances

ToJSON BatchGetRepositories

Defined in Amazonka.CodeCommit.BatchGetRepositories

Methods

toJSON :: BatchGetRepositories -> Value

toEncoding :: BatchGetRepositories -> Encoding

toJSONList :: [BatchGetRepositories] -> Value

toEncodingList :: [BatchGetRepositories] -> Encoding

ToHeaders BatchGetRepositories

Defined in Amazonka.CodeCommit.BatchGetRepositories

Methods

toHeaders :: BatchGetRepositories -> [Header]

ToPath BatchGetRepositories

Defined in Amazonka.CodeCommit.BatchGetRepositories

Methods

toPath :: BatchGetRepositories -> ByteString

ToQuery BatchGetRepositories

Defined in Amazonka.CodeCommit.BatchGetRepositories

Methods

toQuery :: BatchGetRepositories -> QueryString

AWSRequest BatchGetRepositories

Defined in Amazonka.CodeCommit.BatchGetRepositories

Associated Types

type AWSResponse BatchGetRepositories

Methods

request :: (Service -> Service) -> BatchGetRepositories -> Request BatchGetRepositories

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy BatchGetRepositories -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse BatchGetRepositories)))

Generic BatchGetRepositories

Defined in Amazonka.CodeCommit.BatchGetRepositories

Associated Types

type Rep BatchGetRepositories :: Type -> Type

Methods

from :: BatchGetRepositories -> Rep BatchGetRepositories x

to :: Rep BatchGetRepositories x -> BatchGetRepositories

Read BatchGetRepositories

Defined in Amazonka.CodeCommit.BatchGetRepositories

Methods

readsPrec :: Int -> ReadS BatchGetRepositories

readList :: ReadS [BatchGetRepositories]

readPrec :: ReadPrec BatchGetRepositories

readListPrec :: ReadPrec [BatchGetRepositories]

Show BatchGetRepositories

Defined in Amazonka.CodeCommit.BatchGetRepositories

Methods

showsPrec :: Int -> BatchGetRepositories -> ShowS

show :: BatchGetRepositories -> String

showList :: [BatchGetRepositories] -> ShowS

NFData BatchGetRepositories

Defined in Amazonka.CodeCommit.BatchGetRepositories

Methods

rnf :: BatchGetRepositories -> ()

Eq BatchGetRepositories

Defined in Amazonka.CodeCommit.BatchGetRepositories

Methods

(==) :: BatchGetRepositories -> BatchGetRepositories -> Bool

(/=) :: BatchGetRepositories -> BatchGetRepositories -> Bool

Hashable BatchGetRepositories

Defined in Amazonka.CodeCommit.BatchGetRepositories

Methods

hashWithSalt :: Int -> BatchGetRepositories -> Int

hash :: BatchGetRepositories -> Int

type AWSResponse BatchGetRepositories

Defined in Amazonka.CodeCommit.BatchGetRepositories

type AWSResponse BatchGetRepositories = BatchGetRepositoriesResponse

type Rep BatchGetRepositories

Defined in Amazonka.CodeCommit.BatchGetRepositories

type Rep BatchGetRepositories = D1 ('MetaData "BatchGetRepositories" "Amazonka.CodeCommit.BatchGetRepositories" "amazonka-codecommit-2.0-974g5LOhuTPG9HgUSx02zG" 'False) (C1 ('MetaCons "BatchGetRepositories'" 'PrefixI 'True) (S1 ('MetaSel ('Just "repositoryNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text])))

newBatchGetRepositories :: BatchGetRepositories

Create a value of BatchGetRepositories 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:repositoryNames:BatchGetRepositories', batchGetRepositories_repositoryNames - The names of the repositories to get information about.

The length constraint limit is for each string in the array. The array itself can be empty.

Request Lenses

batchGetRepositories_repositoryNames :: Lens' BatchGetRepositories [Text]

The names of the repositories to get information about.

The length constraint limit is for each string in the array. The array itself can be empty.

Destructuring the Response

data BatchGetRepositoriesResponse

Represents the output of a batch get repositories operation.

See: newBatchGetRepositoriesResponse smart constructor.

Constructors

BatchGetRepositoriesResponse'

Fields

• repositories :: Maybe [RepositoryMetadata]

  A list of repositories returned by the batch get repositories operation.

• repositoriesNotFound :: Maybe [Text]

  Returns a list of repository names for which information could not be found.

• httpStatus :: Int

  The response's http status code.

Instances

Generic BatchGetRepositoriesResponse

Defined in Amazonka.CodeCommit.BatchGetRepositories

Associated Types

type Rep BatchGetRepositoriesResponse :: Type -> Type

Methods

from :: BatchGetRepositoriesResponse -> Rep BatchGetRepositoriesResponse x

to :: Rep BatchGetRepositoriesResponse x -> BatchGetRepositoriesResponse

Read BatchGetRepositoriesResponse

Defined in Amazonka.CodeCommit.BatchGetRepositories

Methods

readsPrec :: Int -> ReadS BatchGetRepositoriesResponse

readList :: ReadS [BatchGetRepositoriesResponse]

readPrec :: ReadPrec BatchGetRepositoriesResponse

readListPrec :: ReadPrec [BatchGetRepositoriesResponse]

Show BatchGetRepositoriesResponse

Defined in Amazonka.CodeCommit.BatchGetRepositories

Methods

showsPrec :: Int -> BatchGetRepositoriesResponse -> ShowS

show :: BatchGetRepositoriesResponse -> String

showList :: [BatchGetRepositoriesResponse] -> ShowS

NFData BatchGetRepositoriesResponse

Defined in Amazonka.CodeCommit.BatchGetRepositories

Methods

rnf :: BatchGetRepositoriesResponse -> ()

Eq BatchGetRepositoriesResponse

Defined in Amazonka.CodeCommit.BatchGetRepositories

Methods

(==) :: BatchGetRepositoriesResponse -> BatchGetRepositoriesResponse -> Bool

(/=) :: BatchGetRepositoriesResponse -> BatchGetRepositoriesResponse -> Bool

type Rep BatchGetRepositoriesResponse

Defined in Amazonka.CodeCommit.BatchGetRepositories

type Rep BatchGetRepositoriesResponse = D1 ('MetaData "BatchGetRepositoriesResponse" "Amazonka.CodeCommit.BatchGetRepositories" "amazonka-codecommit-2.0-974g5LOhuTPG9HgUSx02zG" 'False) (C1 ('MetaCons "BatchGetRepositoriesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "repositories") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [RepositoryMetadata])) :*: (S1 ('MetaSel ('Just "repositoriesNotFound") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newBatchGetRepositoriesResponse

Arguments

:: Int

$sel:httpStatus:BatchGetRepositoriesResponse'

-> BatchGetRepositoriesResponse

Create a value of BatchGetRepositoriesResponse 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:repositories:BatchGetRepositoriesResponse', batchGetRepositoriesResponse_repositories - A list of repositories returned by the batch get repositories operation.

$sel:repositoriesNotFound:BatchGetRepositoriesResponse', batchGetRepositoriesResponse_repositoriesNotFound - Returns a list of repository names for which information could not be found.

$sel:httpStatus:BatchGetRepositoriesResponse', batchGetRepositoriesResponse_httpStatus - The response's http status code.

Response Lenses

batchGetRepositoriesResponse_repositories :: Lens' BatchGetRepositoriesResponse (Maybe [RepositoryMetadata])

A list of repositories returned by the batch get repositories operation.

batchGetRepositoriesResponse_repositoriesNotFound :: Lens' BatchGetRepositoriesResponse (Maybe [Text])

Returns a list of repository names for which information could not be found.

batchGetRepositoriesResponse_httpStatus :: Lens' BatchGetRepositoriesResponse Int

The response's http status code.