get_service_last_accessed_details_with_entities¶
Operation¶
get_service_last_accessed_details_with_entities
¶
get_service_last_accessed_details_with_entities(request: GetServiceLastAccessedDetailsWithEntitiesInput | GetServiceLastAccessedDetailsWithEntitiesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetServiceLastAccessedDetailsWithEntitiesInputDict]) -> GetServiceLastAccessedDetailsWithEntitiesOutput
After you generate a group or policy report using the
GenerateServiceLastAccessedDetails operation, you can use the JobId
parameter in GetServiceLastAccessedDetailsWithEntities. This operation
retrieves the status of your report job and a list of entities that
could have used group or policy permissions to access the specified
service.
-
Group -- For a group report, this operation returns a list of users in the group that could have used the group's policies in an attempt to access the service.
-
Policy -- For a policy report, this operation returns a list of entities (users or roles) that could have used the policy in an attempt to access the service.
You can also use this operation for user or role reports to retrieve details about those entities.
If the operation fails, the GetServiceLastAccessedDetailsWithEntities
operation returns the reason that it failed.
By default, the list of associated entities is sorted by date, with the most recent access listed first.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
GetServiceLastAccessedDetailsWithEntitiesInput | GetServiceLastAccessedDetailsWithEntitiesInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[GetServiceLastAccessedDetailsWithEntitiesInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetServiceLastAccessedDetailsWithEntitiesOutput
|
An instance of |
get_service_last_accessed_details_with_entities
async
¶
get_service_last_accessed_details_with_entities(request: GetServiceLastAccessedDetailsWithEntitiesInput | GetServiceLastAccessedDetailsWithEntitiesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetServiceLastAccessedDetailsWithEntitiesInputDict]) -> GetServiceLastAccessedDetailsWithEntitiesOutput
After you generate a group or policy report using the
GenerateServiceLastAccessedDetails operation, you can use the JobId
parameter in GetServiceLastAccessedDetailsWithEntities. This operation
retrieves the status of your report job and a list of entities that
could have used group or policy permissions to access the specified
service.
-
Group -- For a group report, this operation returns a list of users in the group that could have used the group's policies in an attempt to access the service.
-
Policy -- For a policy report, this operation returns a list of entities (users or roles) that could have used the policy in an attempt to access the service.
You can also use this operation for user or role reports to retrieve details about those entities.
If the operation fails, the GetServiceLastAccessedDetailsWithEntities
operation returns the reason that it failed.
By default, the list of associated entities is sorted by date, with the most recent access listed first.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
GetServiceLastAccessedDetailsWithEntitiesInput | GetServiceLastAccessedDetailsWithEntitiesInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[GetServiceLastAccessedDetailsWithEntitiesInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetServiceLastAccessedDetailsWithEntitiesOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
GetServiceLastAccessedDetailsWithEntitiesInputDict
¶
Bases: TypedDict
Dictionary form of GetServiceLastAccessedDetailsWithEntitiesInput.
Attributes¶
job_id
instance-attribute
¶
The ID of the request generated by the
GenerateServiceLastAccessedDetails operation.
marker
instance-attribute
¶
marker: str | None
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.
max_items
instance-attribute
¶
max_items: int | None
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.
service_namespace
instance-attribute
¶
The service namespace for an Amazon Web Services service. Provide the service namespace to learn when the IAM entity last attempted to access the specified service.
To learn the service namespace for a service, see Actions, resources,
and condition keys for Amazon Web Services
services
in the IAM User Guide. Choose the name of the service to view details
for that service. In the first paragraph, find the service prefix. For
example, (service prefix: a4b). For more information about service
namespaces, see Amazon Web Services service
namespaces
in the Amazon Web Services General Reference.
GetServiceLastAccessedDetailsWithEntitiesInput
dataclass
¶
Bases: _SerdeShape
Dataclass for GetServiceLastAccessedDetailsWithEntitiesInput structure.
Attributes¶
job_id
class-attribute
instance-attribute
¶
job_id: str | None = ...
The ID of the request generated by the
GenerateServiceLastAccessedDetails operation.
marker
class-attribute
instance-attribute
¶
marker: str | None = ...
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.
max_items
class-attribute
instance-attribute
¶
max_items: int | None = ...
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.
service_namespace
class-attribute
instance-attribute
¶
service_namespace: str | None = ...
The service namespace for an Amazon Web Services service. Provide the service namespace to learn when the IAM entity last attempted to access the specified service.
To learn the service namespace for a service, see Actions, resources,
and condition keys for Amazon Web Services
services
in the IAM User Guide. Choose the name of the service to view details
for that service. In the first paragraph, find the service prefix. For
example, (service prefix: a4b). For more information about service
namespaces, see Amazon Web Services service
namespaces
in the Amazon Web Services General Reference.
Output¶
GetServiceLastAccessedDetailsWithEntitiesOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for GetServiceLastAccessedDetailsWithEntitiesOutput structure.
Attributes¶
entity_details_list
instance-attribute
¶
entity_details_list: list[EntityDetails]
An EntityDetailsList object that contains details about when an IAM
entity (user or role) used group or policy permissions in an attempt to
access the specified Amazon Web Services service.
error
class-attribute
instance-attribute
¶
error: ErrorDetails | None = ...
An object that contains details about the reason the operation failed.
is_truncated
class-attribute
instance-attribute
¶
is_truncated: bool = ...
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.
job_completion_date
instance-attribute
¶
job_completion_date: datetime
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.
job_creation_date
instance-attribute
¶
job_creation_date: datetime
The date and time, in ISO 8601 date-time format, when the report job was created.
marker
class-attribute
instance-attribute
¶
marker: str | None = ...
When IsTruncated is true, this element is present and contains the
value to use for the Marker parameter in a subsequent pagination
request.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.