diff --git a/.changelog/b6438003a81743bd94cc81a64d5125fd.json b/.changelog/b6438003a81743bd94cc81a64d5125fd.json new file mode 100644 index 00000000000..cd05b81cf2f --- /dev/null +++ b/.changelog/b6438003a81743bd94cc81a64d5125fd.json @@ -0,0 +1,8 @@ +{ + "id": "b6438003-a817-43bd-94cc-81a64d5125fd", + "type": "feature", + "description": "Allow CreateSubscriber API to take string input that allows setting more descriptive SubscriberDescription field. Make souceTypes field required in model level for UpdateSubscriberRequest as it is required for every API call on the backend. Allow ListSubscribers take any String as nextToken param.", + "modules": [ + "service/securitylake" + ] +} \ No newline at end of file diff --git a/service/mgn/internal/endpoints/endpoints.go b/service/mgn/internal/endpoints/endpoints.go index efcb758e260..19275a81fac 100644 --- a/service/mgn/internal/endpoints/endpoints.go +++ b/service/mgn/internal/endpoints/endpoints.go @@ -183,6 +183,42 @@ var defaultPartitions = endpoints.Partitions{ endpoints.EndpointKey{ Region: "eu-west-3", }: endpoints.Endpoint{}, + endpoints.EndpointKey{ + Region: "fips-us-east-1", + }: endpoints.Endpoint{ + Hostname: "mgn-fips.us-east-1.amazonaws.com", + CredentialScope: endpoints.CredentialScope{ + Region: "us-east-1", + }, + Deprecated: aws.TrueTernary, + }, + endpoints.EndpointKey{ + Region: "fips-us-east-2", + }: endpoints.Endpoint{ + Hostname: "mgn-fips.us-east-2.amazonaws.com", + CredentialScope: endpoints.CredentialScope{ + Region: "us-east-2", + }, + Deprecated: aws.TrueTernary, + }, + endpoints.EndpointKey{ + Region: "fips-us-west-1", + }: endpoints.Endpoint{ + Hostname: "mgn-fips.us-west-1.amazonaws.com", + CredentialScope: endpoints.CredentialScope{ + Region: "us-west-1", + }, + Deprecated: aws.TrueTernary, + }, + endpoints.EndpointKey{ + Region: "fips-us-west-2", + }: endpoints.Endpoint{ + Hostname: "mgn-fips.us-west-2.amazonaws.com", + CredentialScope: endpoints.CredentialScope{ + Region: "us-west-2", + }, + Deprecated: aws.TrueTernary, + }, endpoints.EndpointKey{ Region: "me-south-1", }: endpoints.Endpoint{}, @@ -192,15 +228,39 @@ var defaultPartitions = endpoints.Partitions{ endpoints.EndpointKey{ Region: "us-east-1", }: endpoints.Endpoint{}, + endpoints.EndpointKey{ + Region: "us-east-1", + Variant: endpoints.FIPSVariant, + }: { + Hostname: "mgn-fips.us-east-1.amazonaws.com", + }, endpoints.EndpointKey{ Region: "us-east-2", }: endpoints.Endpoint{}, + endpoints.EndpointKey{ + Region: "us-east-2", + Variant: endpoints.FIPSVariant, + }: { + Hostname: "mgn-fips.us-east-2.amazonaws.com", + }, endpoints.EndpointKey{ Region: "us-west-1", }: endpoints.Endpoint{}, + endpoints.EndpointKey{ + Region: "us-west-1", + Variant: endpoints.FIPSVariant, + }: { + Hostname: "mgn-fips.us-west-1.amazonaws.com", + }, endpoints.EndpointKey{ Region: "us-west-2", }: endpoints.Endpoint{}, + endpoints.EndpointKey{ + Region: "us-west-2", + Variant: endpoints.FIPSVariant, + }: { + Hostname: "mgn-fips.us-west-2.amazonaws.com", + }, }, }, { diff --git a/service/securitylake/api_op_CreateAwsLogSource.go b/service/securitylake/api_op_CreateAwsLogSource.go index 0bc29b129e2..69a71767b30 100644 --- a/service/securitylake/api_op_CreateAwsLogSource.go +++ b/service/securitylake/api_op_CreateAwsLogSource.go @@ -11,20 +11,21 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Adds a natively-supported Amazon Web Services service as a Security Lake source. -// Enables source types for member accounts in required Regions, based on specified -// parameters. You can choose any source type in any Region for accounts that are -// either part of a trusted organization or standalone accounts. At least one of -// the three dimensions is a mandatory input to this API. However, any combination -// of the three dimensions can be supplied to this API. By default, dimension -// refers to the entire set. When you don't provide a dimension, Security Lake -// assumes that the missing dimension refers to the entire set. This is overridden -// when you supply any one of the inputs. For instance, when members is not -// specified, the API disables all Security Lake member accounts for sources. -// Similarly, when Regions are not specified, Security Lake is disabled for all the -// Regions where Security Lake is available as a service. You can use this API only -// to enable a natively-supported Amazon Web Services services as a source. Use -// CreateCustomLogSource to enable data collection from a custom source. +// Adds a natively supported Amazon Web Service as an Amazon Security Lake source. +// Enables source types for member accounts in required Amazon Web Services +// Regions, based on the parameters you specify. You can choose any source type in +// any Region for either accounts that are part of a trusted organization or +// standalone accounts. At least one of the three dimensions is a mandatory input +// to this API. However, you can supply any combination of the three dimensions to +// this API. By default, a dimension refers to the entire set. When you don't +// provide a dimension, Security Lake assumes that the missing dimension refers to +// the entire set. This is overridden when you supply any one of the inputs. For +// instance, when you do not specify members, the API enables all Security Lake +// member accounts for all sources. Similarly, when you do not specify Regions, +// Security Lake is enabled for all the Regions where Security Lake is available as +// a service. You can use this API only to enable natively supported Amazon Web +// Services as a source. Use CreateCustomLogSource to enable data collection from a +// custom source. func (c *Client) CreateAwsLogSource(ctx context.Context, params *CreateAwsLogSourceInput, optFns ...func(*Options)) (*CreateAwsLogSourceOutput, error) { if params == nil { params = &CreateAwsLogSourceInput{} @@ -42,19 +43,22 @@ func (c *Client) CreateAwsLogSource(ctx context.Context, params *CreateAwsLogSou type CreateAwsLogSourceInput struct { - // Specifies the input order to enable dimensions in Security Lake, namely region, + // Specifies the input order to enable dimensions in Security Lake, namely Region, // source type, and member account. // // This member is required. InputOrder []types.Dimension - // Enables specific sources in all Regions and source types. + // Enables data collection from specific Amazon Web Services sources in all + // specific accounts and specific Regions. EnableAllDimensions map[string]map[string][]string - // Enables all sources in specific accounts or Regions. + // Enables data collection from all Amazon Web Services sources in specific + // accounts or Regions. EnableSingleDimension []string - // Enables specific service sources in specific accounts or Regions. + // Enables data collection from specific Amazon Web Services sources in specific + // accounts or Regions. EnableTwoDimensions map[string][]string noSmithyDocumentSerde @@ -62,13 +66,13 @@ type CreateAwsLogSourceInput struct { type CreateAwsLogSourceOutput struct { - // List of all accounts in which enabling a natively-supported Amazon Web Services - // service as a Security Lake failed. The failure occurred as these accounts are - // not part of an organization. + // Lists all accounts in which enabling a natively supported Amazon Web Service as + // a Security Lake source failed. The failure occurred as these accounts are not + // part of an organization. Failed []string - // List of all accounts which are in the process of enabling a natively-supported - // Amazon Web Services service as a Security Lake. + // Lists the accounts that are in the process of enabling a natively supported + // Amazon Web Service as a Security Lake source. Processing []string // Metadata pertaining to the operation's result. diff --git a/service/securitylake/api_op_CreateCustomLogSource.go b/service/securitylake/api_op_CreateCustomLogSource.go index 9c1930cab3b..d09d777dad0 100644 --- a/service/securitylake/api_op_CreateCustomLogSource.go +++ b/service/securitylake/api_op_CreateCustomLogSource.go @@ -11,12 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Adds a third-party custom source in Amazon Security Lake, from the Region where -// you want to create a custom source. Security Lake can collect logs and events -// from third-party custom sources. After creating the appropriate API roles, use -// this API to add a custom source name in Security Lake. This operation creates a -// partition in the Security Lake S3 bucket as the target location for log files -// from the custom source, an associated Glue table, and an Glue crawler. +// Adds a third-party custom source in Amazon Security Lake, from the Amazon Web +// Services Region where you want to create a custom source. Security Lake can +// collect logs and events from third-party custom sources. After creating the +// appropriate IAM role to invoke Glue crawler, use this API to add a custom source +// name in Security Lake. This operation creates a partition in the Amazon S3 +// bucket for Security Lake as the target location for log files from the custom +// source in addition to an associated Glue table and an Glue crawler. func (c *Client) CreateCustomLogSource(ctx context.Context, params *CreateCustomLogSourceInput, optFns ...func(*Options)) (*CreateCustomLogSourceOutput, error) { if params == nil { params = &CreateCustomLogSourceInput{} @@ -34,28 +35,32 @@ func (c *Client) CreateCustomLogSource(ctx context.Context, params *CreateCustom type CreateCustomLogSourceInput struct { - // The custom source name for a third-party custom source. + // The name for a third-party custom source. This must be a Regionally unique + // value. // // This member is required. CustomSourceName *string - // The Open Cybersecurity Schema Framework (OCSF) event class. + // The Open Cybersecurity Schema Framework (OCSF) event class which describes the + // type of data that the custom source will send to Security Lake. // // This member is required. EventClass types.OcsfEventClass - // The IAM Role ARN to be used by the Glue Crawler. The recommended IAM policies - // are: + // The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role + // to be used by the Glue crawler. The recommended IAM policies are: // - // * The managed policy AWSGlueServiceRole + // * The managed + // policy AWSGlueServiceRole // - // * A custom policy granting access - // to your S3 Data Lake + // * A custom policy granting access to your Amazon S3 + // Data Lake // // This member is required. GlueInvocationRoleArn *string - // The Account ID that will assume the above Role to put logs into the Data Lake. + // The Amazon Web Services account ID of the custom source that will write logs and + // events into the Amazon S3 Data Lake. // // This member is required. LogProviderAccountId *string @@ -65,7 +70,7 @@ type CreateCustomLogSourceInput struct { type CreateCustomLogSourceOutput struct { - // The location of the partition in the Security Lake S3 bucket. + // The location of the partition in the Amazon S3 bucket for Security Lake. // // This member is required. CustomDataLocation *string @@ -86,11 +91,11 @@ type CreateCustomLogSourceOutput struct { // This member is required. GlueTableName *string - // IAM Role ARN to be used by the entity putting logs into your Custom Source - // partition. Security Lake will apply the correct access policies to this Role, - // but this Role must have the trust policy created manually. This Role's name must - // start with the text 'Security Lake'. It must trust the logProviderAccountId to - // assume it. + // The ARN of the IAM role to be used by the entity putting logs into your custom + // source partition. Security Lake will apply the correct access policies to this + // role, but you must first manually create the trust policy for this role. The IAM + // role name must start with the text 'Security Lake'. The IAM role must trust the + // logProviderAccountId to assume the role. // // This member is required. LogProviderAccessRoleArn *string diff --git a/service/securitylake/api_op_CreateDatalake.go b/service/securitylake/api_op_CreateDatalake.go index 440f61bf89b..e1ccabe1509 100644 --- a/service/securitylake/api_op_CreateDatalake.go +++ b/service/securitylake/api_op_CreateDatalake.go @@ -12,20 +12,23 @@ import ( ) // Initializes an Amazon Security Lake instance with the provided (or default) -// configuration. You can enable Security Lake in Regions with customized settings -// in advance before enabling log collection in Regions. You can either use the -// enableAll parameter to specify all Regions or you can specify the Regions you -// want to enable Security Lake using the Regions parameter and configure these -// Regions using the configurations parameter. When the CreateDataLake API is -// called multiple times, if that Region is already enabled, it will update the -// Region if configuration for that Region is provided. If that Region is a new -// Region, it will be set up with the customized configurations if it is specified. -// When you enable Security Lake, it starts ingesting security data after the -// CreateAwsLogSource call. This includes ingesting security data from sources, -// storing data, and making data accessible to subscribers. Security Lake also -// enables all the existing settings and resources that it stores or maintains for -// your account in the current Region, including security log and event data. For -// more information, see the Amazon Security Lake User Guide. +// configuration. You can enable Security Lake in Amazon Web Services Regions with +// customized settings before enabling log collection in Regions. You can either +// use the enableAll parameter to specify all Regions or specify the Regions where +// you want to enable Security Lake. To specify particular Regions, use the Regions +// parameter and then configure these Regions using the configurations parameter. +// If you have already enabled Security Lake in a Region when you call this +// command, the command will update the Region if you provide new configuration +// parameters. If you have not already enabled Security Lake in the Region when you +// call this API, it will set up the data lake in the Region with the specified +// configurations. When you enable Security Lake, it starts ingesting security data +// after the CreateAwsLogSource call. This includes ingesting security data from +// sources, storing data, and making data accessible to subscribers. Security Lake +// also enables all the existing settings and resources that it stores or maintains +// for your Amazon Web Services account in the current Region, including security +// log and event data. For more information, see the Amazon Security Lake User +// Guide +// (https://docs.aws.amazon.com/security-lake/latest/userguide/what-is-security-lake.html). func (c *Client) CreateDatalake(ctx context.Context, params *CreateDatalakeInput, optFns ...func(*Options)) (*CreateDatalakeOutput, error) { if params == nil { params = &CreateDatalakeInput{} @@ -43,23 +46,21 @@ func (c *Client) CreateDatalake(ctx context.Context, params *CreateDatalakeInput type CreateDatalakeInput struct { - // Enable Security Lake with the specified configurations settings to begin - // ingesting security data. + // Specify the Region or Regions that will contribute data to the rollup region. Configurations map[string]types.LakeConfigurationRequest - // Enable Security Lake in all Regions to begin ingesting security data. + // Enable Security Lake in all Regions. EnableAll *bool - // The Role ARN used to create and update the Glue table with partitions generated - // by ingestion and normalization of Amazon Web Services log sources and custom - // sources. + // The Amazon Resource Name (ARN) used to create and update the Glue table. This + // table contains partitions generated by the ingestion and normalization of Amazon + // Web Services log sources and custom sources. MetaStoreManagerRoleArn *string - // Enable Security Lake in the specified Regions to begin ingesting security data. - // To enable Security Lake in specific Amazon Web Services Regions, such as - // us-east-1 or ap-northeast-3, provide the Region codes. For a list of Region - // codes, see Region codes - // (https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints) in + // Enable Security Lake in the specified Regions. To enable Security Lake in + // specific Amazon Web Services Regions, such as us-east-1 or ap-northeast-3, + // provide the Region codes. For a list of Region codes, see Amazon Security Lake + // endpoints (https://docs.aws.amazon.com/general/latest/gr/securitylake.html) in // the Amazon Web Services General Reference. Regions []types.Region diff --git a/service/securitylake/api_op_CreateDatalakeAutoEnable.go b/service/securitylake/api_op_CreateDatalakeAutoEnable.go index 8c10890bb28..a191ee239af 100644 --- a/service/securitylake/api_op_CreateDatalakeAutoEnable.go +++ b/service/securitylake/api_op_CreateDatalakeAutoEnable.go @@ -11,11 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Automatically enable Security Lake in the specified Regions to begin ingesting -// security data. When you choose to enable organization accounts automatically, -// then Security Lake begins to enable new accounts as member accounts as they are -// added to the organization. Security Lake does not enable existing organization -// accounts that are not yet enabled. +// Automatically enables Amazon Security Lake for new member accounts in your +// organization. Security Lake is not automatically enabled for any existing member +// accounts in your organization. func (c *Client) CreateDatalakeAutoEnable(ctx context.Context, params *CreateDatalakeAutoEnableInput, optFns ...func(*Options)) (*CreateDatalakeAutoEnableOutput, error) { if params == nil { params = &CreateDatalakeAutoEnableInput{} @@ -33,8 +31,8 @@ func (c *Client) CreateDatalakeAutoEnable(ctx context.Context, params *CreateDat type CreateDatalakeAutoEnableInput struct { - // Enable Amazon Security Lake with the specified configurations settings to begin - // ingesting security data for new accounts in Security Lake. + // Enable Security Lake with the specified configuration settings to begin + // collecting security data for new accounts in your organization. // // This member is required. ConfigurationForNewAccounts []types.AutoEnableNewRegionConfiguration diff --git a/service/securitylake/api_op_CreateDatalakeDelegatedAdmin.go b/service/securitylake/api_op_CreateDatalakeDelegatedAdmin.go index a9be81d9d25..2f2cf8dcbc7 100644 --- a/service/securitylake/api_op_CreateDatalakeDelegatedAdmin.go +++ b/service/securitylake/api_op_CreateDatalakeDelegatedAdmin.go @@ -10,9 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Designates the Security Lake administrator account for the organization. This -// API can only be called by the organization management account. The organization -// management account cannot be the delegated administrator account. +// Designates the Amazon Security Lake delegated administrator account for the +// organization. This API can only be called by the organization management +// account. The organization management account cannot be the delegated +// administrator account. func (c *Client) CreateDatalakeDelegatedAdmin(ctx context.Context, params *CreateDatalakeDelegatedAdminInput, optFns ...func(*Options)) (*CreateDatalakeDelegatedAdminOutput, error) { if params == nil { params = &CreateDatalakeDelegatedAdminInput{} @@ -30,7 +31,7 @@ func (c *Client) CreateDatalakeDelegatedAdmin(ctx context.Context, params *Creat type CreateDatalakeDelegatedAdminInput struct { - // Account ID of the Security Lake delegated administrator. + // The Amazon Web Services account ID of the Security Lake delegated administrator. // // This member is required. Account *string diff --git a/service/securitylake/api_op_CreateDatalakeExceptionsSubscription.go b/service/securitylake/api_op_CreateDatalakeExceptionsSubscription.go index fe4c5290092..dac6c3a5835 100644 --- a/service/securitylake/api_op_CreateDatalakeExceptionsSubscription.go +++ b/service/securitylake/api_op_CreateDatalakeExceptionsSubscription.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates the specified notification subscription in Security Lake. Creates the -// specified subscription notifications in the specified organization. +// Creates the specified notification subscription in Amazon Security Lake for the +// organization you specify. func (c *Client) CreateDatalakeExceptionsSubscription(ctx context.Context, params *CreateDatalakeExceptionsSubscriptionInput, optFns ...func(*Options)) (*CreateDatalakeExceptionsSubscriptionOutput, error) { if params == nil { params = &CreateDatalakeExceptionsSubscriptionInput{} @@ -30,12 +30,13 @@ func (c *Client) CreateDatalakeExceptionsSubscription(ctx context.Context, param type CreateDatalakeExceptionsSubscriptionInput struct { - // The account in which the exception notifications subscription is created. + // The Amazon Web Services account where you want to receive exception + // notifications. // // This member is required. NotificationEndpoint *string - // The subscription protocol to which exception messages are posted. + // The subscription protocol to which exception notifications are posted. // // This member is required. SubscriptionProtocol types.SubscriptionProtocolType diff --git a/service/securitylake/api_op_CreateSubscriber.go b/service/securitylake/api_op_CreateSubscriber.go index 8a773a10b82..b00a7fa405c 100644 --- a/service/securitylake/api_op_CreateSubscriber.go +++ b/service/securitylake/api_op_CreateSubscriber.go @@ -12,7 +12,8 @@ import ( ) // Creates a subscription permission for accounts that are already enabled in -// Security Lake. +// Amazon Security Lake. You can create a subscriber with access to data in the +// current Amazon Web Services Region. func (c *Client) CreateSubscriber(ctx context.Context, params *CreateSubscriberInput, optFns ...func(*Options)) (*CreateSubscriberOutput, error) { if params == nil { params = &CreateSubscriberInput{} @@ -30,27 +31,27 @@ func (c *Client) CreateSubscriber(ctx context.Context, params *CreateSubscriberI type CreateSubscriberInput struct { - // The third party Amazon Web Services account ID used to access your data. + // The Amazon Web Services account ID used to access your data. // // This member is required. AccountId *string - // The external ID of the subscriber. External ID allows the user that is assuming - // the role to assert the circumstances in which they are operating. It also - // provides a way for the account owner to permit the role to be assumed only under - // specific circumstances. + // The external ID of the subscriber. This lets the user that is assuming the role + // assert the circumstances in which they are operating. It also provides a way for + // the account owner to permit the role to be assumed only under specific + // circumstances. // // This member is required. ExternalId *string - // The supported Amazon Web Services services from which logs and events are - // collected. Amazon Security Lake supports logs and events collection for - // natively-supported Amazon Web Services services. + // The supported Amazon Web Services from which logs and events are collected. + // Security Lake supports log and event collection for natively supported Amazon + // Web Services. // // This member is required. SourceTypes []types.SourceType - // The name of your Amazon Security Lake subscriber account. + // The name of your Security Lake subscriber account. // // This member is required. SubscriberName *string @@ -58,7 +59,7 @@ type CreateSubscriberInput struct { // The Amazon S3 or Lake Formation access type. AccessTypes []types.AccessType - // The subscriber descriptions for the subscriber account in Amazon Security Lake. + // The description for your subscriber account in Security Lake. SubscriberDescription *string noSmithyDocumentSerde @@ -66,20 +67,21 @@ type CreateSubscriberInput struct { type CreateSubscriberOutput struct { - // The subscriptionId that was created by the CreateSubscriber API call. + // The subscriptionId created by the CreateSubscriber API call. // // This member is required. SubscriptionId *string - // The Amazon Resource Name (ARN) created by the user to provide to the subscriber. - // For more information about ARNs and how to use them in policies, see IAM - // identifiers in the IAM User Guide. + // The Amazon Resource Name (ARN) created by you to provide to the subscriber. For + // more information about ARNs and how to use them in policies, see IAM identifiers + // in the Identity and Access Management (IAM) User Guide + // (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html). . RoleArn *string - // The Amazon Resource Name (ARN) for the Amazon S3 bucket. + // The ARN for the Amazon S3 bucket. S3BucketArn *string - // The Amazon Resource Name (ARN) for the Amazon Simple Notification Service. + // The ARN for the Amazon Simple Notification Service. SnsArn *string // Metadata pertaining to the operation's result. diff --git a/service/securitylake/api_op_CreateSubscriptionNotificationConfiguration.go b/service/securitylake/api_op_CreateSubscriptionNotificationConfiguration.go index 0d96c3dcb31..4badc380f8f 100644 --- a/service/securitylake/api_op_CreateSubscriptionNotificationConfiguration.go +++ b/service/securitylake/api_op_CreateSubscriptionNotificationConfiguration.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates the specified notification subscription in Security Lake. Creates the -// specified subscription notifications from the specified organization. +// Notifies the subscriber when new data is written to the data lake for the +// sources that the subscriber consumes in Security Lake. func (c *Client) CreateSubscriptionNotificationConfiguration(ctx context.Context, params *CreateSubscriptionNotificationConfigurationInput, optFns ...func(*Options)) (*CreateSubscriptionNotificationConfigurationOutput, error) { if params == nil { params = &CreateSubscriptionNotificationConfigurationInput{} @@ -30,28 +30,29 @@ func (c *Client) CreateSubscriptionNotificationConfiguration(ctx context.Context type CreateSubscriptionNotificationConfigurationInput struct { - // The subscription ID for which the subscription notification is specified. + // The subscription ID for the notification subscription/ // // This member is required. SubscriptionId *string - // Create a new subscription notification for the specified subscription ID in - // Security Lake. + // Create an Amazon Simple Queue Service queue. CreateSqs *bool - // The key name for the subscription notification. + // The key name for the notification subscription. HttpsApiKeyName *string - // The key value for the subscription notification. + // The key value for the notification subscription. HttpsApiKeyValue *string - // The HTTPS method used for the subscription notification. + // The HTTPS method used for the notification subscription. HttpsMethod types.HttpsMethod - // The Amazon Resource Name (ARN) specifying the role of the subscriber. + // The Amazon Resource Name (ARN) of the EventBridge API destinations IAM role that + // you created. RoleArn *string - // The subscription endpoint in Security Lake. + // The subscription endpoint in Security Lake. If you prefer notification with an + // HTTPs endpoint, populate this field. SubscriptionEndpoint *string noSmithyDocumentSerde @@ -59,7 +60,7 @@ type CreateSubscriptionNotificationConfigurationInput struct { type CreateSubscriptionNotificationConfigurationOutput struct { - // Returns the Amazon resource name (ARN) of the queue. + // Returns the Amazon Resource Name (ARN) of the queue. QueueArn *string // Metadata pertaining to the operation's result. diff --git a/service/securitylake/api_op_DeleteAwsLogSource.go b/service/securitylake/api_op_DeleteAwsLogSource.go index 149f5c25943..001bd7212cf 100644 --- a/service/securitylake/api_op_DeleteAwsLogSource.go +++ b/service/securitylake/api_op_DeleteAwsLogSource.go @@ -11,24 +11,22 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Removes a natively-supported Amazon Web Services service as a Amazon Security -// Lake source. When you remove the source, Security Lake stops collecting data -// from that source, and subscribers can no longer consume new data from the -// source. Subscribers can still consume data that Amazon Security Lake collected -// from the source before disablement. You can choose any source type in any Region -// for accounts that are either part of a trusted organization or standalone +// Removes a natively supported Amazon Web Service as an Amazon Security Lake +// source. When you remove the source, Security Lake stops collecting data from +// that source, and subscribers can no longer consume new data from the source. +// Subscribers can still consume data that Security Lake collected from the source +// before disablement. You can choose any source type in any Amazon Web Services +// Region for either accounts that are part of a trusted organization or standalone // accounts. At least one of the three dimensions is a mandatory input to this API. -// However, any combination of the three dimensions can be supplied to this API. By -// default, dimension refers to the entire set. This is overridden when you supply -// any one of the inputs. For instance, when members is not specified, the API -// disables all Security Lake member accounts for sources. Similarly, when Regions -// are not specified, Security Lake is disabled for all the Regions where Security -// Lake is available as a service. You can use this API to remove a -// natively-supported Amazon Web Services service as a source. Use -// DeregisterCustomData to remove a custom source. When you don't provide a -// dimension, Security Lake assumes that the missing dimension refers to the entire -// set. For example, if you don't provide specific accounts, the API applies to the -// entire set of accounts in your organization. +// However, you can supply any combination of the three dimensions to this API. By +// default, a dimension refers to the entire set. This is overridden when you +// supply any one of the inputs. For instance, when you do not specify members, the +// API disables all Security Lake member accounts for sources. Similarly, when you +// do not specify Regions, Security Lake is disabled for all the Regions where +// Security Lake is available as a service. When you don't provide a dimension, +// Security Lake assumes that the missing dimension refers to the entire set. For +// example, if you don't provide specific accounts, the API applies to the entire +// set of accounts in your organization. func (c *Client) DeleteAwsLogSource(ctx context.Context, params *DeleteAwsLogSourceInput, optFns ...func(*Options)) (*DeleteAwsLogSourceOutput, error) { if params == nil { params = &DeleteAwsLogSourceInput{} @@ -46,14 +44,15 @@ func (c *Client) DeleteAwsLogSource(ctx context.Context, params *DeleteAwsLogSou type DeleteAwsLogSourceInput struct { - // This is a mandatory input. Specifies the input order to disable dimensions in - // Security Lake, namely Region, source type, and member. + // This is a mandatory input. Specify the input order to disable dimensions in + // Security Lake, namely Region (Amazon Web Services Region code, source type, and + // member (account ID of a specific Amazon Web Services account). // // This member is required. InputOrder []types.Dimension - // Removes the specific Amazon Web Services sources from all Regions and source - // types. + // Removes the specific Amazon Web Services sources from specific accounts and + // specific Regions. DisableAllDimensions map[string]map[string][]string // Removes all Amazon Web Services sources from specific accounts or Regions. @@ -71,7 +70,7 @@ type DeleteAwsLogSourceOutput struct { // of the organization. Failed []string - // Deletion of the Amazon Web Services sources is in-progress. + // Deletion of the Amazon Web Services sources is in progress. Processing []string // Metadata pertaining to the operation's result. diff --git a/service/securitylake/api_op_DeleteCustomLogSource.go b/service/securitylake/api_op_DeleteCustomLogSource.go index faf6acf3fd3..62224a2be12 100644 --- a/service/securitylake/api_op_DeleteCustomLogSource.go +++ b/service/securitylake/api_op_DeleteCustomLogSource.go @@ -10,7 +10,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Removes a custom log source from Security Lake. +// Removes a custom log source from Amazon Security Lake. func (c *Client) DeleteCustomLogSource(ctx context.Context, params *DeleteCustomLogSourceInput, optFns ...func(*Options)) (*DeleteCustomLogSourceOutput, error) { if params == nil { params = &DeleteCustomLogSourceInput{} @@ -28,7 +28,7 @@ func (c *Client) DeleteCustomLogSource(ctx context.Context, params *DeleteCustom type DeleteCustomLogSourceInput struct { - // The custom source name for the custome log source. + // The custom source name for the custom log source. // // This member is required. CustomSourceName *string @@ -38,7 +38,7 @@ type DeleteCustomLogSourceInput struct { type DeleteCustomLogSourceOutput struct { - // The location of the partition in the Security Lake S3 bucket. + // The location of the partition in the Amazon S3 bucket for Security Lake. // // This member is required. CustomDataLocation *string diff --git a/service/securitylake/api_op_DeleteDatalake.go b/service/securitylake/api_op_DeleteDatalake.go index 531e0c79a94..e8f92fe7e75 100644 --- a/service/securitylake/api_op_DeleteDatalake.go +++ b/service/securitylake/api_op_DeleteDatalake.go @@ -11,14 +11,16 @@ import ( ) // When you delete Amazon Security Lake from your account, Security Lake is -// disabled in all Regions. Also, this API automatically performs the off-boarding -// steps to off-board the account from Security Lake . This includes ingesting -// security data from sources, storing data, and making data accessible to -// subscribers. Security Lake also deletes all the existing settings and resources -// that it stores or maintains for your account in the current Region, including -// security log and event data. DeleteDatalake does not delete the S3 bucket which -// is owned by the Amazon Web Services account. For more information, see the -// Amazon Security Lake User Guide. +// disabled in all Amazon Web Services Regions. Also, this API automatically takes +// steps to remove the account from Security Lake . This operation disables +// security data collection from sources, deletes data stored, and stops making +// data accessible to subscribers. Security Lake also deletes all the existing +// settings and resources that it stores or maintains for your Amazon Web Services +// account in the current Region, including security log and event data. The +// DeleteDatalake operation does not delete the Amazon S3 bucket, which is owned by +// your Amazon Web Services account. For more information, see the Amazon Security +// Lake User Guide +// (https://docs.aws.amazon.com/security-lake/latest/userguide/disable-security-lake.html). func (c *Client) DeleteDatalake(ctx context.Context, params *DeleteDatalakeInput, optFns ...func(*Options)) (*DeleteDatalakeOutput, error) { if params == nil { params = &DeleteDatalakeInput{} diff --git a/service/securitylake/api_op_DeleteDatalakeAutoEnable.go b/service/securitylake/api_op_DeleteDatalakeAutoEnable.go index c8198549842..dd731e19b8d 100644 --- a/service/securitylake/api_op_DeleteDatalakeAutoEnable.go +++ b/service/securitylake/api_op_DeleteDatalakeAutoEnable.go @@ -11,15 +11,17 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Automatically delete Security Lake in the specified Regions to stop ingesting -// security data. When you delete Amazon Security Lake from your account, Security -// Lake is disabled in all Regions. Also, this API automatically performs the -// off-boarding steps to off-board the account from Security Lake . This includes -// ingesting security data from sources, storing data, and making data accessible -// to subscribers. Security Lake also deletes all the existing settings and -// resources that it stores or maintains for your account in the current Region, -// including security log and event data. For more information, see the Amazon -// Security Lake User Guide. +// Automatically deletes Amazon Security Lake to stop collecting security data. +// When you delete Amazon Security Lake from your account, Security Lake is +// disabled in all Regions. Also, this API automatically takes steps to remove the +// account from Security Lake . This operation disables security data collection +// from sources, deletes data stored, and stops making data accessible to +// subscribers. Security Lake also deletes all the existing settings and resources +// that it stores or maintains for your Amazon Web Services account in the current +// Region, including security log and event data. The DeleteDatalake operation does +// not delete the Amazon S3 bucket, which is owned by your Amazon Web Services +// account. For more information, see the Amazon Security Lake User Guide +// (https://docs.aws.amazon.com/security-lake/latest/userguide/disable-security-lake.html). func (c *Client) DeleteDatalakeAutoEnable(ctx context.Context, params *DeleteDatalakeAutoEnableInput, optFns ...func(*Options)) (*DeleteDatalakeAutoEnableOutput, error) { if params == nil { params = &DeleteDatalakeAutoEnableInput{} @@ -37,7 +39,7 @@ func (c *Client) DeleteDatalakeAutoEnable(ctx context.Context, params *DeleteDat type DeleteDatalakeAutoEnableInput struct { - // Delete Amazon Security Lake with the specified configurations settings to stop + // Delete Amazon Security Lake with the specified configuration settings to stop // ingesting security data for new accounts in Security Lake. // // This member is required. diff --git a/service/securitylake/api_op_DeleteDatalakeDelegatedAdmin.go b/service/securitylake/api_op_DeleteDatalakeDelegatedAdmin.go index 0ccf6574226..ef9f907ca46 100644 --- a/service/securitylake/api_op_DeleteDatalakeDelegatedAdmin.go +++ b/service/securitylake/api_op_DeleteDatalakeDelegatedAdmin.go @@ -10,9 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the Security Lake administrator account for the organization. This API -// can only be called by the organization management account. The organization -// management account cannot be the delegated administrator account. +// Deletes the Amazon Security Lake delegated administrator account for the +// organization. This API can only be called by the organization management +// account. The organization management account cannot be the delegated +// administrator account. func (c *Client) DeleteDatalakeDelegatedAdmin(ctx context.Context, params *DeleteDatalakeDelegatedAdminInput, optFns ...func(*Options)) (*DeleteDatalakeDelegatedAdminOutput, error) { if params == nil { params = &DeleteDatalakeDelegatedAdminInput{} @@ -30,7 +31,7 @@ func (c *Client) DeleteDatalakeDelegatedAdmin(ctx context.Context, params *Delet type DeleteDatalakeDelegatedAdminInput struct { - // Account ID the Security Lake delegated administrator. + // The account ID the Security Lake delegated administrator. // // This member is required. Account *string diff --git a/service/securitylake/api_op_DeleteDatalakeExceptionsSubscription.go b/service/securitylake/api_op_DeleteDatalakeExceptionsSubscription.go index c4fccea3b1b..121cc70f555 100644 --- a/service/securitylake/api_op_DeleteDatalakeExceptionsSubscription.go +++ b/service/securitylake/api_op_DeleteDatalakeExceptionsSubscription.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified notification subscription in Security Lake. Deletes the -// specified subscription notifications in the specified organization. +// Deletes the specified notification subscription in Amazon Security Lake for the +// organization you specify. func (c *Client) DeleteDatalakeExceptionsSubscription(ctx context.Context, params *DeleteDatalakeExceptionsSubscriptionInput, optFns ...func(*Options)) (*DeleteDatalakeExceptionsSubscriptionOutput, error) { if params == nil { params = &DeleteDatalakeExceptionsSubscriptionInput{} diff --git a/service/securitylake/api_op_DeleteSubscriber.go b/service/securitylake/api_op_DeleteSubscriber.go index 6fd60c0b53f..b9495aca53a 100644 --- a/service/securitylake/api_op_DeleteSubscriber.go +++ b/service/securitylake/api_op_DeleteSubscriber.go @@ -10,8 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified subscription permissions to Security Lake. Deletes the -// specified subscription permissions from the specified organization. +// Deletes the subscription permission for accounts that are already enabled in +// Amazon Security Lake. You can delete a subscriber and remove access to data in +// the current Amazon Web Services Region. func (c *Client) DeleteSubscriber(ctx context.Context, params *DeleteSubscriberInput, optFns ...func(*Options)) (*DeleteSubscriberOutput, error) { if params == nil { params = &DeleteSubscriberInput{} diff --git a/service/securitylake/api_op_DeleteSubscriptionNotificationConfiguration.go b/service/securitylake/api_op_DeleteSubscriptionNotificationConfiguration.go index 8e22ccc578c..37ffcaa634a 100644 --- a/service/securitylake/api_op_DeleteSubscriptionNotificationConfiguration.go +++ b/service/securitylake/api_op_DeleteSubscriptionNotificationConfiguration.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified notification subscription in Security Lake. Deletes the -// specified subscription notifications from the specified organization. +// Deletes the specified notification subscription in Amazon Security Lake for the +// organization you specify. func (c *Client) DeleteSubscriptionNotificationConfiguration(ctx context.Context, params *DeleteSubscriptionNotificationConfigurationInput, optFns ...func(*Options)) (*DeleteSubscriptionNotificationConfigurationOutput, error) { if params == nil { params = &DeleteSubscriptionNotificationConfigurationInput{} @@ -29,7 +29,7 @@ func (c *Client) DeleteSubscriptionNotificationConfiguration(ctx context.Context type DeleteSubscriptionNotificationConfigurationInput struct { - // The subscription ID of the Amazon Security Lake subscriber account. + // The ID of the Security Lake subscriber account. // // This member is required. SubscriptionId *string diff --git a/service/securitylake/api_op_GetDatalake.go b/service/securitylake/api_op_GetDatalake.go index f593f09de5c..83b9bb3aa4d 100644 --- a/service/securitylake/api_op_GetDatalake.go +++ b/service/securitylake/api_op_GetDatalake.go @@ -11,8 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieve the Security Lake configuration object for the specified account ID. -// This API does not take input parameters. +// Retrieves the Amazon Security Lake configuration object for the specified Amazon +// Web Services account ID. You can use the GetDatalake API to know whether +// Security Lake is enabled for the current Region. This API does not take input +// parameters. func (c *Client) GetDatalake(ctx context.Context, params *GetDatalakeInput, optFns ...func(*Options)) (*GetDatalakeOutput, error) { if params == nil { params = &GetDatalakeInput{} diff --git a/service/securitylake/api_op_GetDatalakeAutoEnable.go b/service/securitylake/api_op_GetDatalakeAutoEnable.go index f7816223997..195227ab256 100644 --- a/service/securitylake/api_op_GetDatalakeAutoEnable.go +++ b/service/securitylake/api_op_GetDatalakeAutoEnable.go @@ -12,7 +12,7 @@ import ( ) // Retrieves the configuration that will be automatically set up for accounts added -// to the organization after the organization has on boarded to Amazon Security +// to the organization after the organization has onboarded to Amazon Security // Lake. This API does not take input parameters. func (c *Client) GetDatalakeAutoEnable(ctx context.Context, params *GetDatalakeAutoEnableInput, optFns ...func(*Options)) (*GetDatalakeAutoEnableOutput, error) { if params == nil { diff --git a/service/securitylake/api_op_GetDatalakeExceptionsExpiry.go b/service/securitylake/api_op_GetDatalakeExceptionsExpiry.go index f7f54bc9685..7ce97435eed 100644 --- a/service/securitylake/api_op_GetDatalakeExceptionsExpiry.go +++ b/service/securitylake/api_op_GetDatalakeExceptionsExpiry.go @@ -11,9 +11,9 @@ import ( ) // Retrieves the expiration period and time-to-live (TTL) for which the exception -// message will remain. Exceptions are stored by default, for a 2 week period of -// time from when a record was created in Security Lake. This API does not take -// input parameters. This API does not take input parameters. +// message will remain. Exceptions are stored by default, for 2 weeks from when a +// record was created in Amazon Security Lake. This API does not take input +// parameters. func (c *Client) GetDatalakeExceptionsExpiry(ctx context.Context, params *GetDatalakeExceptionsExpiryInput, optFns ...func(*Options)) (*GetDatalakeExceptionsExpiryOutput, error) { if params == nil { params = &GetDatalakeExceptionsExpiryInput{} diff --git a/service/securitylake/api_op_GetDatalakeStatus.go b/service/securitylake/api_op_GetDatalakeStatus.go index b2f879407bf..e908954e7b5 100644 --- a/service/securitylake/api_op_GetDatalakeStatus.go +++ b/service/securitylake/api_op_GetDatalakeStatus.go @@ -12,8 +12,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieve the Security Lake configuration object for the specified account ID. -// This API does not take input parameters. +// Retrieves a snapshot of the current Region, including whether Amazon Security +// Lake is enabled for those accounts and which sources Security Lake is collecting +// data from. func (c *Client) GetDatalakeStatus(ctx context.Context, params *GetDatalakeStatusInput, optFns ...func(*Options)) (*GetDatalakeStatusOutput, error) { if params == nil { params = &GetDatalakeStatusInput{} @@ -31,19 +32,20 @@ func (c *Client) GetDatalakeStatus(ctx context.Context, params *GetDatalakeStatu type GetDatalakeStatusInput struct { - // The account IDs for which a static snapshot of the current Region, including - // enabled accounts and log sources is retrieved. + // The Amazon Web Services account ID for which a static snapshot of the current + // Amazon Web Services Region, including enabled accounts and log sources, is + // retrieved. AccountSet []string // The maximum limit of accounts for which the static snapshot of the current - // Region including enabled accounts and log sources is retrieved. + // Region, including enabled accounts and log sources, is retrieved. MaxAccountResults *int32 - // If nextToken is returned, there are more results available. The value of - // nextToken is a unique pagination token for each page. Make the call again using - // the returned token to retrieve the next page. Keep all other arguments - // unchanged. Each pagination token expires after 24 hours. Using an expired - // pagination token will return an HTTP 400 InvalidToken error. + // Lists if there are more results available. The value of nextToken is a unique + // pagination token for each page. Repeat the call using the returned token to + // retrieve the next page. Keep all other arguments unchanged. Each pagination + // token expires after 24 hours. Using an expired pagination token will return an + // HTTP 400 InvalidToken error. NextToken *string noSmithyDocumentSerde @@ -56,11 +58,11 @@ type GetDatalakeStatusOutput struct { // This member is required. AccountSourcesList []types.AccountSources - // If nextToken is returned, there are more results available. The value of - // nextToken is a unique pagination token for each page. Make the call again using - // the returned token to retrieve the next page. Keep all other arguments - // unchanged. Each pagination token expires after 24 hours. Using an expired - // pagination token will return an HTTP 400 InvalidToken error. + // Lists if there are more results available. The value of nextToken is a unique + // pagination token for each page. Repeat the call using the returned token to + // retrieve the next page. Keep all other arguments unchanged. Each pagination + // token expires after 24 hours. Using an expired pagination token will return an + // HTTP 400 InvalidToken error. NextToken *string // Metadata pertaining to the operation's result. @@ -140,7 +142,7 @@ var _ GetDatalakeStatusAPIClient = (*Client)(nil) // GetDatalakeStatusPaginatorOptions is the paginator options for GetDatalakeStatus type GetDatalakeStatusPaginatorOptions struct { // The maximum limit of accounts for which the static snapshot of the current - // Region including enabled accounts and log sources is retrieved. + // Region, including enabled accounts and log sources, is retrieved. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/securitylake/api_op_GetSubscriber.go b/service/securitylake/api_op_GetSubscriber.go index 57a52257dc6..f6507efa9af 100644 --- a/service/securitylake/api_op_GetSubscriber.go +++ b/service/securitylake/api_op_GetSubscriber.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves subscription information for the specified subscription ID. +// Retrieves the subscription information for the specified subscription ID. You +// can get information about a specific subscriber. func (c *Client) GetSubscriber(ctx context.Context, params *GetSubscriberInput, optFns ...func(*Options)) (*GetSubscriberOutput, error) { if params == nil { params = &GetSubscriberInput{} @@ -29,8 +30,8 @@ func (c *Client) GetSubscriber(ctx context.Context, params *GetSubscriberInput, type GetSubscriberInput struct { - // A value created by Security Lake that uniquely identifies your GetSubscriber API - // request. + // A value created by Amazon Security Lake that uniquely identifies your + // GetSubscriber API request. // // This member is required. Id *string @@ -40,7 +41,7 @@ type GetSubscriberInput struct { type GetSubscriberOutput struct { - // Subscription information for the specified subscription ID + // The subscription information for the specified subscription ID. Subscriber *types.SubscriberResource // Metadata pertaining to the operation's result. diff --git a/service/securitylake/api_op_ListDatalakeExceptions.go b/service/securitylake/api_op_ListDatalakeExceptions.go index a0c7d6bb32c..da162e781da 100644 --- a/service/securitylake/api_op_ListDatalakeExceptions.go +++ b/service/securitylake/api_op_ListDatalakeExceptions.go @@ -12,7 +12,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// List the Amazon Security Lake exceptions that you can use to find the source of +// Lists the Amazon Security Lake exceptions that you can use to find the source of // problems and fix them. func (c *Client) ListDatalakeExceptions(ctx context.Context, params *ListDatalakeExceptionsInput, optFns ...func(*Options)) (*ListDatalakeExceptionsOutput, error) { if params == nil { @@ -34,11 +34,14 @@ type ListDatalakeExceptionsInput struct { // List the maximum number of failures in Security Lake. MaxFailures *int32 - // List if there are more results available. if nextToken is returned, You can make - // the call again using the returned token to retrieve the next page + // List if there are more results available. The value of nextToken is a unique + // pagination token for each page. Repeat the call using the returned token to + // retrieve the next page. Keep all other arguments unchanged. Each pagination + // token expires after 24 hours. Using an expired pagination token will return an + // HTTP 400 InvalidToken error. NextToken *string - // List the regions from which exceptions are retrieved. + // List the Amazon Web Services Regions from which exceptions are retrieved. RegionSet []types.Region noSmithyDocumentSerde @@ -46,13 +49,16 @@ type ListDatalakeExceptionsInput struct { type ListDatalakeExceptionsOutput struct { - // Lists the non-retryable failures in the current region. + // Lists the failures that cannot be retried in the current Region. // // This member is required. NonRetryableFailures []types.FailuresResponse - // List if there are more results available. if nextToken is returned, You can make - // the call again using the returned token to retrieve the next page + // List if there are more results available. The value of nextToken is a unique + // pagination token for each page. Repeat the call using the returned token to + // retrieve the next page. Keep all other arguments unchanged. Each pagination + // token expires after 24 hours. Using an expired pagination token will return an + // HTTP 400 InvalidToken error. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/securitylake/api_op_ListLogSources.go b/service/securitylake/api_op_ListLogSources.go index eb2c2ec2c85..04d44488013 100644 --- a/service/securitylake/api_op_ListLogSources.go +++ b/service/securitylake/api_op_ListLogSources.go @@ -12,7 +12,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the log sources in the current region. +// Retrieves the log sources in the current Amazon Web Services Region. func (c *Client) ListLogSources(ctx context.Context, params *ListLogSourcesInput, optFns ...func(*Options)) (*ListLogSourcesOutput, error) { if params == nil { params = &ListLogSourcesInput{} @@ -34,23 +34,24 @@ type ListLogSourcesInput struct { // account. InputOrder []types.Dimension - // List the view of log sources for enabled Security Lake accounts in all Regions - // and source types. + // List the view of log sources for enabled Amazon Security Lake accounts for + // specific Amazon Web Services sources from specific accounts and specific + // Regions. ListAllDimensions map[string]map[string][]string - // List the view of log sources for enabled Security Lake accounts for the entire - // region. + // List the view of log sources for enabled Security Lake accounts for all Amazon + // Web Services sources from specific accounts or specific Regions. ListSingleDimension []string - // Lists the log sources for the specified source types in enabled Security Lake - // accounts for the entire Region, for selected member accounts. + // Lists the view of log sources for enabled Security Lake accounts for specific + // Amazon Web Services sources from specific accounts or specific Regions. ListTwoDimensions map[string][]string - // The maximum number of accounts for which the configuration is displayed. + // The maximum number of accounts for which the log sources are displayed. MaxResults *int32 - // If nextToken is returned, there are more results available. You can make the - // call again using the returned token to retrieve the next page. + // If nextToken is returned, there are more results available. You can repeat the + // call using the returned token to retrieve the next page. NextToken *string noSmithyDocumentSerde @@ -58,13 +59,13 @@ type ListLogSourcesInput struct { type ListLogSourcesOutput struct { - // Lists the log sources in the Regions for enabled Security Lake accounts. + // Lists the log sources by Regions for enabled Security Lake accounts. // // This member is required. RegionSourceTypesAccountsList []map[string]map[string][]string - // If nextToken is returned, there are more results available. You can make the - // call again using the returned token to retrieve the next page. + // If nextToken is returned, there are more results available. You can repeat the + // call using the returned token to retrieve the next page. NextToken *string // Metadata pertaining to the operation's result. @@ -143,7 +144,7 @@ var _ ListLogSourcesAPIClient = (*Client)(nil) // ListLogSourcesPaginatorOptions is the paginator options for ListLogSources type ListLogSourcesPaginatorOptions struct { - // The maximum number of accounts for which the configuration is displayed. + // The maximum number of accounts for which the log sources are displayed. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/securitylake/api_op_ListSubscribers.go b/service/securitylake/api_op_ListSubscribers.go index 1146f029841..edbe8f5611d 100644 --- a/service/securitylake/api_op_ListSubscribers.go +++ b/service/securitylake/api_op_ListSubscribers.go @@ -12,7 +12,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// List all subscribers for the specific Security Lake account ID. +// List all subscribers for the specific Amazon Security Lake account ID. You can +// retrieve a list of subscriptions associated with a specific organization or +// Amazon Web Services account. func (c *Client) ListSubscribers(ctx context.Context, params *ListSubscribersInput, optFns ...func(*Options)) (*ListSubscribersOutput, error) { if params == nil { params = &ListSubscribersInput{} @@ -33,8 +35,8 @@ type ListSubscribersInput struct { // The maximum number of accounts for which the configuration is displayed. MaxResults *int32 - // If nextToken is returned, there are more results available. You can make the - // call again using the returned token to retrieve the next page. + // If nextToken is returned, there are more results available. You can repeat the + // call using the returned token to retrieve the next page. NextToken *string noSmithyDocumentSerde @@ -42,13 +44,13 @@ type ListSubscribersInput struct { type ListSubscribersOutput struct { - // The subscribers available in the specified Security Lake account ID. + // The subscribers available for the specified Security Lake account ID. // // This member is required. Subscribers []types.SubscriberResource - // If nextToken is returned, there are more results available. You can make the - // call again using the returned token to retrieve the next page. + // If nextToken is returned, there are more results available. You can repeat the + // call using the returned token to retrieve the next page. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/securitylake/api_op_UpdateDatalake.go b/service/securitylake/api_op_UpdateDatalake.go index 26f588359b7..5107b093f9a 100644 --- a/service/securitylake/api_op_UpdateDatalake.go +++ b/service/securitylake/api_op_UpdateDatalake.go @@ -11,10 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Amazon Security Lake allows you to specify where to store your security data and -// for how long. You can specify a rollup Region to consolidate data from multiple -// regions. You can update the properties of a Region or source. Input can either -// be directly specified to the API. +// Specifies where to store your security data and for how long. You can add a +// rollup Region to consolidate data from multiple Amazon Web Services Regions. func (c *Client) UpdateDatalake(ctx context.Context, params *UpdateDatalakeInput, optFns ...func(*Options)) (*UpdateDatalakeOutput, error) { if params == nil { params = &UpdateDatalakeInput{} @@ -32,7 +30,7 @@ func (c *Client) UpdateDatalake(ctx context.Context, params *UpdateDatalakeInput type UpdateDatalakeInput struct { - // The configuration object + // Specify the Region or Regions that will contribute data to the rollup region. // // This member is required. Configurations map[string]types.LakeConfigurationRequest diff --git a/service/securitylake/api_op_UpdateDatalakeExceptionsExpiry.go b/service/securitylake/api_op_UpdateDatalakeExceptionsExpiry.go index 63308bae8d1..f9386f41802 100644 --- a/service/securitylake/api_op_UpdateDatalakeExceptionsExpiry.go +++ b/service/securitylake/api_op_UpdateDatalakeExceptionsExpiry.go @@ -12,8 +12,8 @@ import ( // Update the expiration period for the exception message to your preferred time, // and control the time-to-live (TTL) for the exception message to remain. -// Exceptions are stored by default, for a 2 week period of time from when a record -// was created in Security Lake. +// Exceptions are stored by default for 2 weeks from when a record was created in +// Amazon Security Lake. func (c *Client) UpdateDatalakeExceptionsExpiry(ctx context.Context, params *UpdateDatalakeExceptionsExpiryInput, optFns ...func(*Options)) (*UpdateDatalakeExceptionsExpiryOutput, error) { if params == nil { params = &UpdateDatalakeExceptionsExpiryInput{} diff --git a/service/securitylake/api_op_UpdateDatalakeExceptionsSubscription.go b/service/securitylake/api_op_UpdateDatalakeExceptionsSubscription.go index aefdf75f618..8d7fb275957 100644 --- a/service/securitylake/api_op_UpdateDatalakeExceptionsSubscription.go +++ b/service/securitylake/api_op_UpdateDatalakeExceptionsSubscription.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Update the subscription notification for exception notification. +// Updates the specified notification subscription in Amazon Security Lake for the +// organization you specify. func (c *Client) UpdateDatalakeExceptionsSubscription(ctx context.Context, params *UpdateDatalakeExceptionsSubscriptionInput, optFns ...func(*Options)) (*UpdateDatalakeExceptionsSubscriptionOutput, error) { if params == nil { params = &UpdateDatalakeExceptionsSubscriptionInput{} @@ -29,7 +30,7 @@ func (c *Client) UpdateDatalakeExceptionsSubscription(ctx context.Context, param type UpdateDatalakeExceptionsSubscriptionInput struct { - // The account which is subscribed to receive exception notifications. + // The account that is subscribed to receive exception notifications. // // This member is required. NotificationEndpoint *string diff --git a/service/securitylake/api_op_UpdateSubscriber.go b/service/securitylake/api_op_UpdateSubscriber.go index 2a3df4ed1c0..1b63eee1b9a 100644 --- a/service/securitylake/api_op_UpdateSubscriber.go +++ b/service/securitylake/api_op_UpdateSubscriber.go @@ -11,7 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Update the subscription permission for the given Security Lake account ID. +// Updates an existing subscription for the given Amazon Security Lake account ID. +// You can update a subscriber by changing the sources that the subscriber consumes +// data from. func (c *Client) UpdateSubscriber(ctx context.Context, params *UpdateSubscriberInput, optFns ...func(*Options)) (*UpdateSubscriberOutput, error) { if params == nil { params = &UpdateSubscriberInput{} @@ -29,25 +31,26 @@ func (c *Client) UpdateSubscriber(ctx context.Context, params *UpdateSubscriberI type UpdateSubscriberInput struct { - // A value created by Security Lake that uniquely identifies your UpdateSubscriber - // API request. + // A value created by Security Lake that uniquely identifies your subscription. // // This member is required. Id *string - // External ID of the Security Lake account. - ExternalId *string - - // The supported Amazon Web Services services from which logs and events are - // collected. Amazon Security Lake supports logs and events collection for the - // following natively-supported Amazon Web Services services. For more information, - // see the Amazon Security Lake User Guide. + // The supported Amazon Web Services from which logs and events are collected. For + // the list of supported Amazon Web Services, see the Amazon Security Lake User + // Guide + // (https://docs.aws.amazon.com/security-lake/latest/userguide/internal-sources.html). + // + // This member is required. SourceTypes []types.SourceType - // Description of the Security Lake account subscriber. + // The external ID of the Security Lake account. + ExternalId *string + + // The description of the Security Lake account subscriber. SubscriberDescription *string - // Name of the Security Lake account subscriber. + // The name of the Security Lake account subscriber. SubscriberName *string noSmithyDocumentSerde @@ -55,7 +58,7 @@ type UpdateSubscriberInput struct { type UpdateSubscriberOutput struct { - // The account subscriber in Amazon Security Lake. + // The account of the subscriber. Subscriber *types.SubscriberResource // Metadata pertaining to the operation's result. diff --git a/service/securitylake/api_op_UpdateSubscriptionNotificationConfiguration.go b/service/securitylake/api_op_UpdateSubscriptionNotificationConfiguration.go index 4247e067760..78671aa52b2 100644 --- a/service/securitylake/api_op_UpdateSubscriptionNotificationConfiguration.go +++ b/service/securitylake/api_op_UpdateSubscriptionNotificationConfiguration.go @@ -11,7 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Create a new subscription notification or add the existing subscription +// Creates a new subscription notification or adds the existing subscription // notification setting for the specified subscription ID. func (c *Client) UpdateSubscriptionNotificationConfiguration(ctx context.Context, params *UpdateSubscriptionNotificationConfigurationInput, optFns ...func(*Options)) (*UpdateSubscriptionNotificationConfigurationOutput, error) { if params == nil { @@ -36,7 +36,7 @@ type UpdateSubscriptionNotificationConfigurationInput struct { SubscriptionId *string // Create a new subscription notification for the specified subscription ID in - // Security Lake. + // Amazon Security Lake. CreateSqs *bool // The key name for the subscription notification. @@ -59,7 +59,7 @@ type UpdateSubscriptionNotificationConfigurationInput struct { type UpdateSubscriptionNotificationConfigurationOutput struct { - // Returns the Amazon resource name (ARN) of the queue. + // Returns the ARN of the queue. QueueArn *string // Metadata pertaining to the operation's result. diff --git a/service/securitylake/deserializers.go b/service/securitylake/deserializers.go index c36b69d27e2..f30c100c265 100644 --- a/service/securitylake/deserializers.go +++ b/service/securitylake/deserializers.go @@ -3561,7 +3561,7 @@ func awsRestjson1_deserializeOpDocumentListSubscribersOutput(v **ListSubscribers if value != nil { jtv, ok := value.(string) if !ok { - return fmt.Errorf("expected SafeString to be of type string, got %T instead", value) + return fmt.Errorf("expected String to be of type string, got %T instead", value) } sv.NextToken = ptr.String(jtv) } diff --git a/service/securitylake/doc.go b/service/securitylake/doc.go index 94211d20c0a..971352ad980 100644 --- a/service/securitylake/doc.go +++ b/service/securitylake/doc.go @@ -3,21 +3,39 @@ // Package securitylake provides the API client, operations, and parameter types // for Amazon Security Lake. // -// Amazon Security Lake is in preview release. Your use of the Amazon Security Lake +// Amazon Security Lake is in preview release. Your use of the Security Lake // preview is subject to Section 2 of the Amazon Web Services Service Terms // (http://aws.amazon.com/service-terms/)("Betas and Previews"). Amazon Security -// Lake is a fully-managed security data lake service. You can use Security Lake to +// Lake is a fully managed security data lake service. You can use Security Lake to // automatically centralize security data from cloud, on-premises, and custom -// sources into a data lake that's stored in your account. Security Lake helps you -// analyze security data, so you can get a more complete understanding of your -// security posture across the entire organization and improve the protection of +// sources into a data lake that's stored in your Amazon Web Servicesaccount. +// Amazon Web Services Organizations is an account management service that lets you +// consolidate multiple Amazon Web Services accounts into an organization that you +// create and centrally manage. With Organizations, you can create member accounts +// and invite existing accounts to join your organization. Security Lake helps you +// analyze security data for a more complete understanding of your security posture +// across the entire organization. It can also help you improve the protection of // your workloads, applications, and data. The data lake is backed by Amazon Simple // Storage Service (Amazon S3) buckets, and you retain ownership over your data. +// Amazon Security Lake integrates with CloudTrail, a service that provides a +// record of actions taken by a user, role, or an Amazon Web Services service in +// Security Lake CloudTrail captures API calls for Security Lake as events. The +// calls captured include calls from the Security Lake console and code calls to +// the Security Lake API operations. If you create a trail, you can enable +// continuous delivery of CloudTrail events to an Amazon S3 bucket, including +// events for Security Lake. If you don't configure a trail, you can still view the +// most recent events in the CloudTrail console in Event history. Using the +// information collected by CloudTrail you can determine the request that was made +// to Security Lake, the IP address from which the request was made, who made the +// request, when it was made, and additional details. To learn more about Security +// Lake information in CloudTrail, see the Amazon Security Lake User Guide +// (https://docs.aws.amazon.com/security-lake/latest/userguide/securitylake-cloudtrail.html). // Security Lake automates the collection of security-related log and event data -// from integrated Amazon Web Services. and third-party services and manages the -// lifecycle of data with customizable retention and replication settings. Security -// Lake also converts ingested data into Apache Parquet format and a standard -// open-source schema called the Open Cybersecurity Schema Framework (OCSF). Other -// Amazon Web Services and third-party services can subscribe to the data that's -// stored in Security Lake for incident response and security data analytics. +// from integrated Amazon Web Services and third-party services. It also helps you +// manage the lifecycle of data with customizable retention and replication +// settings. Security Lake converts ingested data into Apache Parquet format and a +// standard open-source schema called the Open Cybersecurity Schema Framework +// (OCSF). Other Amazon Web Services and third-party services can subscribe to the +// data that's stored in Security Lake for incident response and security data +// analytics. package securitylake diff --git a/service/securitylake/types/errors.go b/service/securitylake/types/errors.go index 811d8450d26..4b33081cfd6 100644 --- a/service/securitylake/types/errors.go +++ b/service/securitylake/types/errors.go @@ -31,7 +31,7 @@ func (e *AccessDeniedException) ErrorMessage() string { func (e *AccessDeniedException) ErrorCode() string { return "AccessDeniedException" } func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// Amazon Security Lake can't find an Amazon Web Services account with the +// Amazon Security Lake cannot find an Amazon Web Services account with the // accountID that you specified, or the account whose credentials you used to make // this request isn't a member of an organization. type AccountNotFoundException struct { @@ -197,8 +197,8 @@ func (e *InternalServerException) ErrorMessage() string { func (e *InternalServerException) ErrorCode() string { return "InternalServerException" } func (e *InternalServerException) ErrorFault() smithy.ErrorFault { return smithy.FaultServer } -// The request was rejected because an invalid or out-of-range value was supplied -// for an input parameter. +// The request was rejected because a value that's not valid or is out of range was +// supplied for an input parameter. type InvalidInputException struct { Message *string @@ -241,9 +241,9 @@ func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault { return smit // Provides an extension of the AmazonServiceException for errors reported by // Amazon S3 while processing a request. In particular, this class provides access -// to Amazon S3's extended request ID. This ID is required debugging information in -// the case the user needs to contact Amazon about an issue where Amazon S3 is -// incorrectly handling a request. +// to the Amazon S3 extended request ID. If Amazon S3 is incorrectly handling a +// request and you need to contact Amazon, this extended request ID may provide +// useful debugging information. type S3Exception struct { Message *string diff --git a/service/securitylake/types/types.go b/service/securitylake/types/types.go index 7391b768610..6ca90f299f0 100644 --- a/service/securitylake/types/types.go +++ b/service/securitylake/types/types.go @@ -7,19 +7,20 @@ import ( "time" ) -// Security Lake can collect logs and events from supported Amazon Web Services -// services and custom sources. +// Amazon Security Lake collects logs and events from supported Amazon Web Services +// and custom sources. For the list of supported Amazon Web Services, see the +// Amazon Security Lake User Guide +// (https://docs.aws.amazon.com/security-lake/latest/userguide/internal-sources.html). type AccountSources struct { - // Account ID of the Security Lake account for which logs are collected. + // The ID of the Security Lake account for which logs are collected. // // This member is required. Account *string - // The supported Amazon Web Services services from which logs and events are - // collected. Amazon Security Lake supports logs and events collection for - // natively-supported Amazon Web Services services. For more information, see the - // Amazon Security Lake User Guide. + // The supported Amazon Web Services from which logs and events are collected. + // Amazon Security Lake supports log and event collection for natively supported + // Amazon Web Services. // // This member is required. SourceType *string @@ -27,22 +28,22 @@ type AccountSources struct { // Initializes a new instance of the Event class. EventClass OcsfEventClass - // Log status for the Security Lake account. + // The log status for the Security Lake account. LogsStatus []LogsStatus noSmithyDocumentSerde } -// Automatically enable new organization accounts as member accounts from a +// Automatically enable new organization accounts as member accounts from an Amazon // Security Lake administrator account. type AutoEnableNewRegionConfiguration struct { - // The Regions where Security Lake is auto enabled + // The Amazon Web Services Regions where Security Lake is automatically enabled. // // This member is required. Region Region - // The Amazon Web Services sources which are auto enabled in Security Lake. + // The Amazon Web Services sources that are automatically enabled in Security Lake. // // This member is required. Sources []AwsLogSourceType @@ -72,24 +73,24 @@ type Failures struct { noSmithyDocumentSerde } -// Response element for actions which make changes namely create, update, or delete +// Response element for actions that make changes, namely create, update, or delete // actions. type FailuresResponse struct { // List of all failures. Failures []Failures - // List of Regions where the failure occurred. + // List of Amazon Web Services Regions where the failure occurred. Region *string noSmithyDocumentSerde } -// Provides details of lake configuration object in Amazon Security Lake. +// Provides details of Amazon Security Lake configuration object. type LakeConfigurationRequest struct { - // The type of encryption key used by Security Lake to encrypt the lake - // configuration object. + // The type of encryption key used by Amazon Security Lake to encrypt the Security + // Lake configuration object. EncryptionKey *string // Replication enables automatic, asynchronous copying of objects across Amazon S3 @@ -102,9 +103,9 @@ type LakeConfigurationRequest struct { // rollup Region. ReplicationDestinationRegions []Region - // Replication settings for the Amazon S3 buckets. This parameter uses the IAM role - // created by you that is managed by Security Lake, to ensure the replication - // setting is correct. + // Replication settings for the Amazon S3 buckets. This parameter uses the Identity + // and Access Management (IAM) role you created that is managed by Security Lake, + // to ensure the replication setting is correct. ReplicationRoleArn *string // Retention settings for the destination Amazon S3 buckets. @@ -117,26 +118,26 @@ type LakeConfigurationRequest struct { noSmithyDocumentSerde } -// Provides details of lake configuration object in Amazon Security Lake. +// Provides details of Amazon Security Lake lake configuration object. type LakeConfigurationResponse struct { - // The type of encryption key used by Security Lake to encrypt the lake - // configuration + // The type of encryption key used by secure the Security Lake configuration + // object. EncryptionKey *string // Replication enables automatic, asynchronous copying of objects across Amazon S3 // buckets. Amazon S3 buckets that are configured for object replication can be - // owned by the same AWS account or by different accounts. You can replicate - // objects to a single destination bucket or to multiple destination buckets. The - // destination buckets can be in different Amazon Web Services Regions or within - // the same Region as the source bucket. Set up one or more rollup Regions by - // providing the Region or Regions that should contribute to the central rollup - // Region. + // owned by the same Amazon Web Services account or by different accounts. You can + // replicate objects to a single destination bucket or to multiple destination + // buckets. The destination buckets can be in different Amazon Web Services Regions + // or within the same Region as the source bucket. Set up one or more rollup + // Regions by providing the Region or Regions that should contribute to the central + // rollup Region. ReplicationDestinationRegions []Region // Replication settings for the Amazon S3 buckets. This parameter uses the IAM role - // created by you that is managed by Security Lake, to ensure the replication - // setting is correct. + // you created that is managed by Security Lake, to ensure the replication setting + // is correct. ReplicationRoleArn *string // Retention settings for the destination Amazon S3 buckets. @@ -159,10 +160,10 @@ type LakeConfigurationResponse struct { noSmithyDocumentSerde } -// Log status for the Security Lake account. +// Retrieves the Logs status for the Amazon Security Lake account. type LogsStatus struct { - // Health status of services including error codes and patterns. + // The health status of services, including error codes and patterns. // // This member is required. HealthStatus SourceStatus @@ -176,11 +177,11 @@ type LogsStatus struct { noSmithyDocumentSerde } -// Notifications in Security Lake which dictates how notifications are posted at -// the endpoint. +// Protocol used in Amazon Security Lake that dictates how notifications are posted +// at the endpoint. type ProtocolAndNotificationEndpoint struct { - // The account which is subscribed to receive exception notifications. + // The account that is subscribed to receive exception notifications. Endpoint *string // The protocol to which notification messages are posted. @@ -189,12 +190,13 @@ type ProtocolAndNotificationEndpoint struct { noSmithyDocumentSerde } -// Retention settings for the destination Amazon S3 buckets in Security Lake. +// Retention settings for the destination Amazon S3 buckets in Amazon Security +// Lake. type RetentionSetting struct { // The retention period specifies a fixed period of time during which the Security - // Lake object remains locked. You can specify the retention period for one or more - // source in days. + // Lake object remains locked. You can specify the retention period in days for one + // or more sources. RetentionPeriod *int32 // The range of storage classes that you can choose from based on the data access, @@ -205,7 +207,9 @@ type RetentionSetting struct { } // The supported source types from which logs and events are collected in Amazon -// Security Lake. +// Security Lake. For the list of supported Amazon Web Services, see the Amazon +// Security Lake User Guide +// (https://docs.aws.amazon.com/security-lake/latest/userguide/internal-sources.html). // // The following types satisfy this interface: // @@ -215,9 +219,8 @@ type SourceType interface { isSourceType() } -// Amazon Security Lake supports logs and events collection for natively-supported -// Amazon Web Services services. For more information, see the Amazon Security Lake -// User Guide. +// Amazon Security Lake supports log and event collection for natively supported +// Amazon Web Services. type SourceTypeMemberAwsSourceType struct { Value AwsLogSourceType @@ -226,8 +229,8 @@ type SourceTypeMemberAwsSourceType struct { func (*SourceTypeMemberAwsSourceType) isSourceType() {} -// Amazon Security Lake supports custom source types. For the detailed list, see -// the Amazon Security Lake User Guide. +// Amazon Security Lake supports custom source types. For a detailed list, see the +// Amazon Security Lake User Guide. type SourceTypeMemberCustomSourceType struct { Value string @@ -236,20 +239,20 @@ type SourceTypeMemberCustomSourceType struct { func (*SourceTypeMemberCustomSourceType) isSourceType() {} -// Provides details of the Amazon Security Lake account subscription. Subscribers -// are notified of new objects for a source as the data is written to your Amazon -// Security Lake S3 bucket. +// Provides details about the Amazon Security Lake account subscription. +// Subscribers are notified of new objects for a source as the data is written to +// your Amazon S3 bucket for Security Lake. type SubscriberResource struct { - // The Amazon Web Services account ID of the account that you are using to create - // your Amazon Security Lake account. + // The Amazon Web Services account ID you are using to create your Amazon Security + // Lake account. // // This member is required. AccountId *string - // Amazon Security Lake supports logs and events collection for the - // natively-supported Amazon Web Services services. For more information, see the - // Amazon Security Lake User Guide. + // Amazon Security Lake supports log and event collection for natively supported + // Amazon Web Services. For more information, see the Amazon Security Lake User + // Guide. // // This member is required. SourceTypes []SourceType @@ -262,15 +265,15 @@ type SubscriberResource struct { // You can choose to notify subscribers of new objects with an Amazon Simple Queue // Service (Amazon SQS) queue or through messaging to an HTTPS endpoint provided by // the subscriber. Subscribers can consume data by directly querying Lake Formation - // tables in your S3 bucket via services like Amazon Athena. This subscription type - // is defined as LAKEFORMATION. + // tables in your Amazon S3 bucket through services like Amazon Athena. This + // subscription type is defined as LAKEFORMATION. AccessTypes []AccessType // The date and time when the subscription was created. CreatedAt *time.Time - // The external ID of the subscriber. External ID allows the user that is assuming - // the role to assert the circumstances in which they are operating. It also + // The external ID of the subscriber. The external ID lets the user that is + // assuming the role assert the circumstances in which they are operating. It also // provides a way for the account owner to permit the role to be assumed only under // specific circumstances. ExternalId *string @@ -278,10 +281,10 @@ type SubscriberResource struct { // The Amazon Resource Name (ARN) specifying the role of the subscriber. RoleArn *string - // The Amazon Resource Name (ARN) for the Amazon S3 bucket. + // The ARN for the Amazon S3 bucket. S3BucketArn *string - // The Amazon Resource Name (ARN) for the Amazon Simple Notification Service. + // The ARN for the Amazon Simple Notification Service. SnsArn *string // The subscriber descriptions for a subscriber account. The description for a @@ -297,7 +300,7 @@ type SubscriberResource struct { // The subscription protocol to which exception messages are posted. SubscriptionProtocol EndpointProtocol - // Subscription status of the Amazon Security Lake subscriber account. + // The subscription status of the Amazon Security Lake subscriber account. SubscriptionStatus SubscriptionStatus // The date and time when the subscription was created. @@ -306,7 +309,7 @@ type SubscriberResource struct { noSmithyDocumentSerde } -// The input fails to meet the constraints specified in Amazon Security Lake +// The input fails to meet the constraints specified in Amazon Security Lake. type ValidationExceptionField struct { // Describes the error encountered. diff --git a/service/securitylake/validators.go b/service/securitylake/validators.go index dc5cb8d2f22..d2379117176 100644 --- a/service/securitylake/validators.go +++ b/service/securitylake/validators.go @@ -796,6 +796,9 @@ func validateOpUpdateSubscriberInput(v *UpdateSubscriberInput) error { if v.Id == nil { invalidParams.Add(smithy.NewErrParamRequired("Id")) } + if v.SourceTypes == nil { + invalidParams.Add(smithy.NewErrParamRequired("SourceTypes")) + } if invalidParams.Len() > 0 { return invalidParams } else {