libZSservicesZSamazonka-iamZSamazonka-iam
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.IAM.GetOrganizationsAccessReport

Description

Retrieves the service last accessed data report for Organizations that was previously generated using the GenerateOrganizationsAccessReport operation. This operation retrieves the status of your report job and the report contents.

Depending on the parameters that you passed when you generated the report, the data returned could include different information. For details, see GenerateOrganizationsAccessReport.

To call this operation, you must be signed in to the management account in your organization. SCPs must be enabled for your organization root. You must have permissions to perform this operation. For more information, see Refining permissions using service last accessed data in the IAM User Guide.

For each service that principals in an account (root users, IAM users, or IAM roles) could access using SCPs, the operation returns details about the most recent access attempt. If there was no attempt, the service is listed without details about the most recent attempt to access the service. If the operation fails, it returns the reason that it failed.

By default, the list is sorted by service namespace.

Synopsis

Creating a Request

data GetOrganizationsAccessReport Source #

See: newGetOrganizationsAccessReport smart constructor.

Constructors

GetOrganizationsAccessReport' 

Fields

  • sortKey :: Maybe SortKeyType

    The key that is used to sort the results. If you choose the namespace key, the results are returned in alphabetical order. If you choose the time key, the results are sorted numerically by the date and time.

  • marker :: Maybe Text

    Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

  • maxItems :: Maybe Natural

    Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

    If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

  • jobId :: Text

    The identifier of the request generated by the GenerateOrganizationsAccessReport operation.

Instances

Instances details
Eq GetOrganizationsAccessReport Source # 
Instance details

Defined in Amazonka.IAM.GetOrganizationsAccessReport

Read GetOrganizationsAccessReport Source # 
Instance details

Defined in Amazonka.IAM.GetOrganizationsAccessReport

Show GetOrganizationsAccessReport Source # 
Instance details

Defined in Amazonka.IAM.GetOrganizationsAccessReport

Generic GetOrganizationsAccessReport Source # 
Instance details

Defined in Amazonka.IAM.GetOrganizationsAccessReport

Associated Types

type Rep GetOrganizationsAccessReport :: Type -> Type #

NFData GetOrganizationsAccessReport Source # 
Instance details

Defined in Amazonka.IAM.GetOrganizationsAccessReport

Hashable GetOrganizationsAccessReport Source # 
Instance details

Defined in Amazonka.IAM.GetOrganizationsAccessReport

AWSRequest GetOrganizationsAccessReport Source # 
Instance details

Defined in Amazonka.IAM.GetOrganizationsAccessReport

ToHeaders GetOrganizationsAccessReport Source # 
Instance details

Defined in Amazonka.IAM.GetOrganizationsAccessReport

ToPath GetOrganizationsAccessReport Source # 
Instance details

Defined in Amazonka.IAM.GetOrganizationsAccessReport

ToQuery GetOrganizationsAccessReport Source # 
Instance details

Defined in Amazonka.IAM.GetOrganizationsAccessReport

type Rep GetOrganizationsAccessReport Source # 
Instance details

Defined in Amazonka.IAM.GetOrganizationsAccessReport

type Rep GetOrganizationsAccessReport = D1 ('MetaData "GetOrganizationsAccessReport" "Amazonka.IAM.GetOrganizationsAccessReport" "libZSservicesZSamazonka-iamZSamazonka-iam" 'False) (C1 ('MetaCons "GetOrganizationsAccessReport'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "sortKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SortKeyType)) :*: S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "maxItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse GetOrganizationsAccessReport Source # 
Instance details

Defined in Amazonka.IAM.GetOrganizationsAccessReport

newGetOrganizationsAccessReport Source #

Create a value of GetOrganizationsAccessReport 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:sortKey:GetOrganizationsAccessReport', getOrganizationsAccessReport_sortKey - The key that is used to sort the results. If you choose the namespace key, the results are returned in alphabetical order. If you choose the time key, the results are sorted numerically by the date and time.

$sel:marker:GetOrganizationsAccessReport', getOrganizationsAccessReport_marker - Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

$sel:maxItems:GetOrganizationsAccessReport', getOrganizationsAccessReport_maxItems - Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

$sel:jobId:GetOrganizationsAccessReport', getOrganizationsAccessReport_jobId - The identifier of the request generated by the GenerateOrganizationsAccessReport operation.

Request Lenses

getOrganizationsAccessReport_sortKey :: Lens' GetOrganizationsAccessReport (Maybe SortKeyType) Source #

The key that is used to sort the results. If you choose the namespace key, the results are returned in alphabetical order. If you choose the time key, the results are sorted numerically by the date and time.

getOrganizationsAccessReport_marker :: Lens' GetOrganizationsAccessReport (Maybe Text) Source #

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

getOrganizationsAccessReport_maxItems :: Lens' GetOrganizationsAccessReport (Maybe Natural) Source #

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

getOrganizationsAccessReport_jobId :: Lens' GetOrganizationsAccessReport Text Source #

The identifier of the request generated by the GenerateOrganizationsAccessReport operation.

Destructuring the Response

data GetOrganizationsAccessReportResponse Source #

Constructors

GetOrganizationsAccessReportResponse' 

Fields

Instances

Instances details
Eq GetOrganizationsAccessReportResponse Source # 
Instance details

Defined in Amazonka.IAM.GetOrganizationsAccessReport

Read GetOrganizationsAccessReportResponse Source # 
Instance details

Defined in Amazonka.IAM.GetOrganizationsAccessReport

Show GetOrganizationsAccessReportResponse Source # 
Instance details

Defined in Amazonka.IAM.GetOrganizationsAccessReport

Generic GetOrganizationsAccessReportResponse Source # 
Instance details

Defined in Amazonka.IAM.GetOrganizationsAccessReport

NFData GetOrganizationsAccessReportResponse Source # 
Instance details

Defined in Amazonka.IAM.GetOrganizationsAccessReport

type Rep GetOrganizationsAccessReportResponse Source # 
Instance details

Defined in Amazonka.IAM.GetOrganizationsAccessReport

type Rep GetOrganizationsAccessReportResponse = D1 ('MetaData "GetOrganizationsAccessReportResponse" "Amazonka.IAM.GetOrganizationsAccessReport" "libZSservicesZSamazonka-iamZSamazonka-iam" 'False) (C1 ('MetaCons "GetOrganizationsAccessReportResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "numberOfServicesNotAccessed") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "jobCompletionDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601))) :*: (S1 ('MetaSel ('Just "accessDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AccessDetail])) :*: (S1 ('MetaSel ('Just "numberOfServicesAccessible") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "errorDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ErrorDetails)) :*: S1 ('MetaSel ('Just "isTruncated") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: (S1 ('MetaSel ('Just "jobStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 JobStatusType) :*: S1 ('MetaSel ('Just "jobCreationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ISO8601))))))

newGetOrganizationsAccessReportResponse Source #

Create a value of GetOrganizationsAccessReportResponse 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:numberOfServicesNotAccessed:GetOrganizationsAccessReportResponse', getOrganizationsAccessReportResponse_numberOfServicesNotAccessed - The number of services that account principals are allowed but did not attempt to access.

$sel:jobCompletionDate:GetOrganizationsAccessReportResponse', getOrganizationsAccessReportResponse_jobCompletionDate - The date and time, in ISO 8601 date-time format, when the generated report job was completed or failed.

This field is null if the job is still in progress, as indicated by a job status value of IN_PROGRESS.

$sel:accessDetails:GetOrganizationsAccessReportResponse', getOrganizationsAccessReportResponse_accessDetails - An object that contains details about the most recent attempt to access the service.

$sel:numberOfServicesAccessible:GetOrganizationsAccessReportResponse', getOrganizationsAccessReportResponse_numberOfServicesAccessible - The number of services that the applicable SCPs allow account principals to access.

$sel:marker:GetOrganizationsAccessReport', getOrganizationsAccessReportResponse_marker - When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

$sel:errorDetails:GetOrganizationsAccessReportResponse', getOrganizationsAccessReportResponse_errorDetails - Undocumented member.

$sel:isTruncated:GetOrganizationsAccessReportResponse', getOrganizationsAccessReportResponse_isTruncated - A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

$sel:httpStatus:GetOrganizationsAccessReportResponse', getOrganizationsAccessReportResponse_httpStatus - The response's http status code.

$sel:jobStatus:GetOrganizationsAccessReportResponse', getOrganizationsAccessReportResponse_jobStatus - The status of the job.

$sel:jobCreationDate:GetOrganizationsAccessReportResponse', getOrganizationsAccessReportResponse_jobCreationDate - The date and time, in ISO 8601 date-time format, when the report job was created.

Response Lenses

getOrganizationsAccessReportResponse_numberOfServicesNotAccessed :: Lens' GetOrganizationsAccessReportResponse (Maybe Int) Source #

The number of services that account principals are allowed but did not attempt to access.

getOrganizationsAccessReportResponse_jobCompletionDate :: Lens' GetOrganizationsAccessReportResponse (Maybe UTCTime) Source #

The date and time, in ISO 8601 date-time format, when the generated report job was completed or failed.

This field is null if the job is still in progress, as indicated by a job status value of IN_PROGRESS.

getOrganizationsAccessReportResponse_accessDetails :: Lens' GetOrganizationsAccessReportResponse (Maybe [AccessDetail]) Source #

An object that contains details about the most recent attempt to access the service.

getOrganizationsAccessReportResponse_numberOfServicesAccessible :: Lens' GetOrganizationsAccessReportResponse (Maybe Int) Source #

The number of services that the applicable SCPs allow account principals to access.

getOrganizationsAccessReportResponse_marker :: Lens' GetOrganizationsAccessReportResponse (Maybe Text) Source #

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

getOrganizationsAccessReportResponse_isTruncated :: Lens' GetOrganizationsAccessReportResponse (Maybe Bool) Source #

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.