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.FSx.DescribeDataRepositoryAssociations

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns the description of specific Amazon FSx for Lustre or Amazon File Cache data repository associations, if one or more AssociationIds values are provided in the request, or if filters are used in the request. Data repository associations are supported only for Amazon FSx for Lustre file systems with the Persistent_2 deployment type and for Amazon File Cache resources.

You can use filters to narrow the response to include just data repository associations for specific file systems (use the file-system-id filter with the ID of the file system) or caches (use the file-cache-id filter with the ID of the cache), or data repository associations for a specific repository type (use the data-repository-type filter with a value of S3 or NFS). If you don't use filters, the response returns all data repository associations owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.

When retrieving all data repository associations, you can paginate the response by using the optional MaxResults parameter to limit the number of data repository associations returned in a response. If more data repository associations remain, a NextToken value is returned in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.

Synopsis

Creating a Request

data DescribeDataRepositoryAssociations Source #

See: newDescribeDataRepositoryAssociations smart constructor.

Constructors

DescribeDataRepositoryAssociations'
Fields associationIds :: Maybe [Text] IDs of the data repository associations whose descriptions you want to retrieve (String). filters :: Maybe [Filter] maxResults :: Maybe Natural The maximum number of resources to return in the response. This value must be an integer greater than zero. nextToken :: Maybe Text

Instances

Instances details

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

newDescribeDataRepositoryAssociations :: DescribeDataRepositoryAssociations Source #

Create a value of DescribeDataRepositoryAssociations 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:associationIds:DescribeDataRepositoryAssociations', describeDataRepositoryAssociations_associationIds - IDs of the data repository associations whose descriptions you want to retrieve (String).

$sel:filters:DescribeDataRepositoryAssociations', describeDataRepositoryAssociations_filters - Undocumented member.

$sel:maxResults:DescribeDataRepositoryAssociations', describeDataRepositoryAssociations_maxResults - The maximum number of resources to return in the response. This value must be an integer greater than zero.

DescribeDataRepositoryAssociations, describeDataRepositoryAssociations_nextToken - Undocumented member.

Request Lenses

describeDataRepositoryAssociations_associationIds :: Lens' DescribeDataRepositoryAssociations (Maybe [Text]) Source #

IDs of the data repository associations whose descriptions you want to retrieve (String).

describeDataRepositoryAssociations_filters :: Lens' DescribeDataRepositoryAssociations (Maybe [Filter]) Source #

Undocumented member.

describeDataRepositoryAssociations_maxResults :: Lens' DescribeDataRepositoryAssociations (Maybe Natural) Source #

The maximum number of resources to return in the response. This value must be an integer greater than zero.

describeDataRepositoryAssociations_nextToken :: Lens' DescribeDataRepositoryAssociations (Maybe Text) Source #

Undocumented member.

Destructuring the Response

data DescribeDataRepositoryAssociationsResponse Source #

See: newDescribeDataRepositoryAssociationsResponse smart constructor.

Constructors

DescribeDataRepositoryAssociationsResponse'
Fields associations :: Maybe [DataRepositoryAssociation] An array of one or more data repository association descriptions. nextToken :: Maybe Text httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DescribeDataRepositoryAssociationsResponse Source #
Instance details Defined in Amazonka.FSx.DescribeDataRepositoryAssociations Associated Types type Rep DescribeDataRepositoryAssociationsResponse :: Type -> Type # Methods from :: DescribeDataRepositoryAssociationsResponse -> Rep DescribeDataRepositoryAssociationsResponse x # to :: Rep DescribeDataRepositoryAssociationsResponse x -> DescribeDataRepositoryAssociationsResponse #
Read DescribeDataRepositoryAssociationsResponse Source #
Instance details Defined in Amazonka.FSx.DescribeDataRepositoryAssociations Methods readsPrec :: Int -> ReadS DescribeDataRepositoryAssociationsResponse # readList :: ReadS [DescribeDataRepositoryAssociationsResponse] # readPrec :: ReadPrec DescribeDataRepositoryAssociationsResponse # readListPrec :: ReadPrec [DescribeDataRepositoryAssociationsResponse] #
Show DescribeDataRepositoryAssociationsResponse Source #
Instance details Defined in Amazonka.FSx.DescribeDataRepositoryAssociations Methods showsPrec :: Int -> DescribeDataRepositoryAssociationsResponse -> ShowS # show :: DescribeDataRepositoryAssociationsResponse -> String # showList :: [DescribeDataRepositoryAssociationsResponse] -> ShowS #
NFData DescribeDataRepositoryAssociationsResponse Source #
Instance details Defined in Amazonka.FSx.DescribeDataRepositoryAssociations Methods rnf :: DescribeDataRepositoryAssociationsResponse -> () #
Eq DescribeDataRepositoryAssociationsResponse Source #
Instance details Defined in Amazonka.FSx.DescribeDataRepositoryAssociations Methods (==) :: DescribeDataRepositoryAssociationsResponse -> DescribeDataRepositoryAssociationsResponse -> Bool # (/=) :: DescribeDataRepositoryAssociationsResponse -> DescribeDataRepositoryAssociationsResponse -> Bool #
type Rep DescribeDataRepositoryAssociationsResponse Source #
Instance details Defined in Amazonka.FSx.DescribeDataRepositoryAssociations type Rep DescribeDataRepositoryAssociationsResponse = D1 ('MetaData "DescribeDataRepositoryAssociationsResponse" "Amazonka.FSx.DescribeDataRepositoryAssociations" "amazonka-fsx-2.0-6W1DYEEbHPkD4DJvTvpQG4" 'False) (C1 ('MetaCons "DescribeDataRepositoryAssociationsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "associations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DataRepositoryAssociation])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeDataRepositoryAssociationsResponse Source #

Arguments

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

Create a value of DescribeDataRepositoryAssociationsResponse 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:associations:DescribeDataRepositoryAssociationsResponse', describeDataRepositoryAssociationsResponse_associations - An array of one or more data repository association descriptions.

DescribeDataRepositoryAssociations, describeDataRepositoryAssociationsResponse_nextToken - Undocumented member.

$sel:httpStatus:DescribeDataRepositoryAssociationsResponse', describeDataRepositoryAssociationsResponse_httpStatus - The response's http status code.

Response Lenses

describeDataRepositoryAssociationsResponse_associations :: Lens' DescribeDataRepositoryAssociationsResponse (Maybe [DataRepositoryAssociation]) Source #

An array of one or more data repository association descriptions.

describeDataRepositoryAssociationsResponse_nextToken :: Lens' DescribeDataRepositoryAssociationsResponse (Maybe Text) Source #

Undocumented member.

describeDataRepositoryAssociationsResponse_httpStatus :: Lens' DescribeDataRepositoryAssociationsResponse Int Source #

The response's http status code.