Synopsis
Calls the Amazon Relational Database Service DescribeEvents API operation.
Syntax
Get-RDSEvent-SourceIdentifier <String>-SourceType <SourceType>-Duration <Int32>-EndTime <DateTime>-UtcEndTime <DateTime>-EventCategory <String[]>-Filter <Filter[]>-StartTime <DateTime>-UtcStartTime <DateTime>-Marker <String>-MaxRecord <Int32>
Description
Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days. Events specific to a particular DB instance, DB security group, database snapshot, or DB parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.
This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output.
This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output.
Parameters
-Duration <Int32>
The number of minutes to retrieve events for.Default: 60
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-EndTime <DateTime>
This property is deprecated. Setting this property results in non-UTC DateTimes not being marshalled correctly. Use EndTimeUtc instead. Setting either EndTime or EndTimeUtc results in both EndTime and EndTimeUtc being assigned, the latest assignment to either one of the two property is reflected in the value of both. EndTime is provided for backwards compatibility only and assigning a non-Utc DateTime to it results in the wrong timestamp being passed to the service. The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.Example: 2009-07-08T18:00ZThis parameter is deprecated.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-EventCategory <String[]>
A list of event categories that trigger notifications for a event notification subscription.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-Filter <Filter[]>
This parameter is not currently supported.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-Marker <String>
An optional pagination token provided by a previous DescribeEvents request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
Note: This parameter is only used if you are manually controlling output pagination of the service API call.
MaxRecords. Note: This parameter is only used if you are manually controlling output pagination of the service API call.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-MaxRecord <Int32>
The maximum number of records to include in the response. If more records exist than the specified
Note: This parameter is only used if you are manually controlling output pagination of the service API call.
MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100Constraints: Minimum 20, maximum 100.Note: This parameter is only used if you are manually controlling output pagination of the service API call.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-SourceIdentifier <String>
The identifier of the event source for which events are returned. If not specified, then all sources are included in the response.Constraints:
- If SourceIdentifier is supplied, SourceType must also be provided.
- If the source type is
DBInstance, then aDBInstanceIdentifiermust be supplied. - If the source type is
DBSecurityGroup, aDBSecurityGroupNamemust be supplied. - If the source type is
DBParameterGroup, aDBParameterGroupNamemust be supplied. - If the source type is
DBSnapshot, aDBSnapshotIdentifiermust be supplied. - Can't end with a hyphen or contain two consecutive hyphens.
| Required? | False |
| Position? | 1 |
| Accept pipeline input? | True (ByValue, ByPropertyName) |
-SourceType <SourceType>
The event source to retrieve events for. If no value is specified, all events are returned.
| Required? | False |
| Position? | 2 |
| Accept pipeline input? | False |
-StartTime <DateTime>
This property is deprecated. Setting this property results in non-UTC DateTimes not being marshalled correctly. Use StartTimeUtc instead. Setting either StartTime or StartTimeUtc results in both StartTime and StartTimeUtc being assigned, the latest assignment to either one of the two property is reflected in the value of both. StartTime is provided for backwards compatibility only and assigning a non-Utc DateTime to it results in the wrong timestamp being passed to the service. The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.Example: 2009-07-08T18:00ZThis parameter is deprecated.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-UtcEndTime <DateTime>
The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.Example: 2009-07-08T18:00Z
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-UtcStartTime <DateTime>
The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.Example: 2009-07-08T18:00Z
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
Common Credential and Region Parameters
-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key
if the corresponding session token is supplied to the -SessionToken parameter.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information,
and optionally a token for session-based credentials.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)
If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials. Note that the encrypted credential file is not supported on all platforms. It will be skipped when searching for profiles on Windows Nano Server, Mac, and Linux platforms.
If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.
As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing
credential information. The profile is expected to be found in the secure credential
file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also
specify the name of a profile stored in the .ini-format credential file used with
the AWS CLI and other AWS SDKs.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile.
Contains the network credentials to be supplied during authentication with the
configured identity provider's endpoint. This parameter is not required if the
user's default network identity can or should be used during authentication.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key
if the corresponding session token is supplied to the -SessionToken parameter.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-SessionToken <String>
The session token if the access and secret keys are temporary session-based
credentials.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-Region <String>
The system name of the AWS region in which the operation should be invoked. For example, us-east-1, eu-west-1 etc.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-EndpointUrl <String>
The endpoint to make the call against.
Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
Inputs
You can pipe a String object to this cmdlet for the SourceIdentifier parameter.
Outputs
This cmdlet returns a collection of Event objects.
The service call response (type Amazon.RDS.Model.DescribeEventsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: Marker (type System.String)
Related Links
Supported Version
AWS Tools for PowerShell: 2.x.y.z
