Documentation ¶
Overview ¶
Package m2 provides the API client, operations, and parameter types for AWSMainframeModernization.
Amazon Web Services Mainframe Modernization provides tools and resources to help you plan and implement migration and modernization from mainframes to Amazon Web Services managed runtime environments. It provides tools for analyzing existing mainframe applications, developing or updating mainframe applications using COBOL or PL/I, and implementing an automated pipeline for continuous integration and continuous delivery (CI/CD) of the applications.
Index ¶
- Constants
- func NewDefaultEndpointResolver() *internalendpoints.Resolver
- func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
- func WithEndpointResolver(v EndpointResolver) func(*Options)deprecated
- func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)
- func WithSigV4SigningName(name string) func(*Options)
- func WithSigV4SigningRegion(region string) func(*Options)
- type AuthResolverParameters
- type AuthSchemeResolver
- type CancelBatchJobExecutionInput
- type CancelBatchJobExecutionOutput
- type Client
- func (c *Client) CancelBatchJobExecution(ctx context.Context, params *CancelBatchJobExecutionInput, ...) (*CancelBatchJobExecutionOutput, error)
- func (c *Client) CreateApplication(ctx context.Context, params *CreateApplicationInput, optFns ...func(*Options)) (*CreateApplicationOutput, error)
- func (c *Client) CreateDataSetImportTask(ctx context.Context, params *CreateDataSetImportTaskInput, ...) (*CreateDataSetImportTaskOutput, error)
- func (c *Client) CreateDeployment(ctx context.Context, params *CreateDeploymentInput, optFns ...func(*Options)) (*CreateDeploymentOutput, error)
- func (c *Client) CreateEnvironment(ctx context.Context, params *CreateEnvironmentInput, optFns ...func(*Options)) (*CreateEnvironmentOutput, error)
- func (c *Client) DeleteApplication(ctx context.Context, params *DeleteApplicationInput, optFns ...func(*Options)) (*DeleteApplicationOutput, error)
- func (c *Client) DeleteApplicationFromEnvironment(ctx context.Context, params *DeleteApplicationFromEnvironmentInput, ...) (*DeleteApplicationFromEnvironmentOutput, error)
- func (c *Client) DeleteEnvironment(ctx context.Context, params *DeleteEnvironmentInput, optFns ...func(*Options)) (*DeleteEnvironmentOutput, error)
- func (c *Client) GetApplication(ctx context.Context, params *GetApplicationInput, optFns ...func(*Options)) (*GetApplicationOutput, error)
- func (c *Client) GetApplicationVersion(ctx context.Context, params *GetApplicationVersionInput, ...) (*GetApplicationVersionOutput, error)
- func (c *Client) GetBatchJobExecution(ctx context.Context, params *GetBatchJobExecutionInput, ...) (*GetBatchJobExecutionOutput, error)
- func (c *Client) GetDataSetDetails(ctx context.Context, params *GetDataSetDetailsInput, optFns ...func(*Options)) (*GetDataSetDetailsOutput, error)
- func (c *Client) GetDataSetImportTask(ctx context.Context, params *GetDataSetImportTaskInput, ...) (*GetDataSetImportTaskOutput, error)
- func (c *Client) GetDeployment(ctx context.Context, params *GetDeploymentInput, optFns ...func(*Options)) (*GetDeploymentOutput, error)
- func (c *Client) GetEnvironment(ctx context.Context, params *GetEnvironmentInput, optFns ...func(*Options)) (*GetEnvironmentOutput, error)
- func (c *Client) GetSignedBluinsightsUrl(ctx context.Context, params *GetSignedBluinsightsUrlInput, ...) (*GetSignedBluinsightsUrlOutput, error)
- func (c *Client) ListApplicationVersions(ctx context.Context, params *ListApplicationVersionsInput, ...) (*ListApplicationVersionsOutput, error)
- func (c *Client) ListApplications(ctx context.Context, params *ListApplicationsInput, optFns ...func(*Options)) (*ListApplicationsOutput, error)
- func (c *Client) ListBatchJobDefinitions(ctx context.Context, params *ListBatchJobDefinitionsInput, ...) (*ListBatchJobDefinitionsOutput, error)
- func (c *Client) ListBatchJobExecutions(ctx context.Context, params *ListBatchJobExecutionsInput, ...) (*ListBatchJobExecutionsOutput, error)
- func (c *Client) ListBatchJobRestartPoints(ctx context.Context, params *ListBatchJobRestartPointsInput, ...) (*ListBatchJobRestartPointsOutput, error)
- func (c *Client) ListDataSetImportHistory(ctx context.Context, params *ListDataSetImportHistoryInput, ...) (*ListDataSetImportHistoryOutput, error)
- func (c *Client) ListDataSets(ctx context.Context, params *ListDataSetsInput, optFns ...func(*Options)) (*ListDataSetsOutput, error)
- func (c *Client) ListDeployments(ctx context.Context, params *ListDeploymentsInput, optFns ...func(*Options)) (*ListDeploymentsOutput, error)
- func (c *Client) ListEngineVersions(ctx context.Context, params *ListEngineVersionsInput, optFns ...func(*Options)) (*ListEngineVersionsOutput, error)
- func (c *Client) ListEnvironments(ctx context.Context, params *ListEnvironmentsInput, optFns ...func(*Options)) (*ListEnvironmentsOutput, error)
- func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, ...) (*ListTagsForResourceOutput, error)
- func (c *Client) Options() Options
- func (c *Client) StartApplication(ctx context.Context, params *StartApplicationInput, optFns ...func(*Options)) (*StartApplicationOutput, error)
- func (c *Client) StartBatchJob(ctx context.Context, params *StartBatchJobInput, optFns ...func(*Options)) (*StartBatchJobOutput, error)
- func (c *Client) StopApplication(ctx context.Context, params *StopApplicationInput, optFns ...func(*Options)) (*StopApplicationOutput, error)
- func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
- func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
- func (c *Client) UpdateApplication(ctx context.Context, params *UpdateApplicationInput, optFns ...func(*Options)) (*UpdateApplicationOutput, error)
- func (c *Client) UpdateEnvironment(ctx context.Context, params *UpdateEnvironmentInput, optFns ...func(*Options)) (*UpdateEnvironmentOutput, error)
- type CreateApplicationInput
- type CreateApplicationOutput
- type CreateDataSetImportTaskInput
- type CreateDataSetImportTaskOutput
- type CreateDeploymentInput
- type CreateDeploymentOutput
- type CreateEnvironmentInput
- type CreateEnvironmentOutput
- type DeleteApplicationFromEnvironmentInput
- type DeleteApplicationFromEnvironmentOutput
- type DeleteApplicationInput
- type DeleteApplicationOutput
- type DeleteEnvironmentInput
- type DeleteEnvironmentOutput
- type EndpointParameters
- type EndpointResolver
- type EndpointResolverFunc
- type EndpointResolverOptions
- type EndpointResolverV2
- type GetApplicationInput
- type GetApplicationOutput
- type GetApplicationVersionInput
- type GetApplicationVersionOutput
- type GetBatchJobExecutionInput
- type GetBatchJobExecutionOutput
- type GetDataSetDetailsInput
- type GetDataSetDetailsOutput
- type GetDataSetImportTaskInput
- type GetDataSetImportTaskOutput
- type GetDeploymentInput
- type GetDeploymentOutput
- type GetEnvironmentInput
- type GetEnvironmentOutput
- type GetSignedBluinsightsUrlInput
- type GetSignedBluinsightsUrlOutput
- type HTTPClient
- type HTTPSignerV4
- type IdempotencyTokenProvider
- type ListApplicationVersionsAPIClient
- type ListApplicationVersionsInput
- type ListApplicationVersionsOutput
- type ListApplicationVersionsPaginator
- type ListApplicationVersionsPaginatorOptions
- type ListApplicationsAPIClient
- type ListApplicationsInput
- type ListApplicationsOutput
- type ListApplicationsPaginator
- type ListApplicationsPaginatorOptions
- type ListBatchJobDefinitionsAPIClient
- type ListBatchJobDefinitionsInput
- type ListBatchJobDefinitionsOutput
- type ListBatchJobDefinitionsPaginator
- type ListBatchJobDefinitionsPaginatorOptions
- type ListBatchJobExecutionsAPIClient
- type ListBatchJobExecutionsInput
- type ListBatchJobExecutionsOutput
- type ListBatchJobExecutionsPaginator
- type ListBatchJobExecutionsPaginatorOptions
- type ListBatchJobRestartPointsInput
- type ListBatchJobRestartPointsOutput
- type ListDataSetImportHistoryAPIClient
- type ListDataSetImportHistoryInput
- type ListDataSetImportHistoryOutput
- type ListDataSetImportHistoryPaginator
- type ListDataSetImportHistoryPaginatorOptions
- type ListDataSetsAPIClient
- type ListDataSetsInput
- type ListDataSetsOutput
- type ListDataSetsPaginator
- type ListDataSetsPaginatorOptions
- type ListDeploymentsAPIClient
- type ListDeploymentsInput
- type ListDeploymentsOutput
- type ListDeploymentsPaginator
- type ListDeploymentsPaginatorOptions
- type ListEngineVersionsAPIClient
- type ListEngineVersionsInput
- type ListEngineVersionsOutput
- type ListEngineVersionsPaginator
- type ListEngineVersionsPaginatorOptions
- type ListEnvironmentsAPIClient
- type ListEnvironmentsInput
- type ListEnvironmentsOutput
- type ListEnvironmentsPaginator
- type ListEnvironmentsPaginatorOptions
- type ListTagsForResourceInput
- type ListTagsForResourceOutput
- type Options
- type ResolveEndpoint
- type StartApplicationInput
- type StartApplicationOutput
- type StartBatchJobInput
- type StartBatchJobOutput
- type StopApplicationInput
- type StopApplicationOutput
- type TagResourceInput
- type TagResourceOutput
- type UntagResourceInput
- type UntagResourceOutput
- type UpdateApplicationInput
- type UpdateApplicationOutput
- type UpdateEnvironmentInput
- type UpdateEnvironmentOutput
Constants ¶
const ServiceAPIVersion = "2021-04-28"
const ServiceID = "m2"
Variables ¶
This section is empty.
Functions ¶
func NewDefaultEndpointResolver ¶
func NewDefaultEndpointResolver() *internalendpoints.Resolver
NewDefaultEndpointResolver constructs a new service endpoint resolver
func WithAPIOptions ¶
func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
WithAPIOptions returns a functional option for setting the Client's APIOptions option.
func WithEndpointResolver
deprecated
func WithEndpointResolver(v EndpointResolver) func(*Options)
Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint.
To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.
func WithEndpointResolverV2 ¶ added in v1.7.0
func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)
WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.
func WithSigV4SigningName ¶ added in v1.9.2
WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.
This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.
func WithSigV4SigningRegion ¶ added in v1.9.2
WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.
This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.
Types ¶
type AuthResolverParameters ¶ added in v1.9.2
type AuthResolverParameters struct { // The name of the operation being invoked. Operation string // The region in which the operation is being invoked. Region string }
AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.
type AuthSchemeResolver ¶ added in v1.9.2
type AuthSchemeResolver interface {
ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}
AuthSchemeResolver returns a set of possible authentication options for an operation.
type CancelBatchJobExecutionOutput ¶
type CancelBatchJobExecutionOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client provides the API client to make operations call for AWSMainframeModernization.
func New ¶
New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.
func NewFromConfig ¶
NewFromConfig returns a new client from the provided config.
func (*Client) CancelBatchJobExecution ¶
func (c *Client) CancelBatchJobExecution(ctx context.Context, params *CancelBatchJobExecutionInput, optFns ...func(*Options)) (*CancelBatchJobExecutionOutput, error)
Cancels the running of a specific batch job execution.
func (*Client) CreateApplication ¶
func (c *Client) CreateApplication(ctx context.Context, params *CreateApplicationInput, optFns ...func(*Options)) (*CreateApplicationOutput, error)
Creates a new application with given parameters. Requires an existing runtime environment and application definition file.
func (*Client) CreateDataSetImportTask ¶
func (c *Client) CreateDataSetImportTask(ctx context.Context, params *CreateDataSetImportTaskInput, optFns ...func(*Options)) (*CreateDataSetImportTaskOutput, error)
Starts a data set import task for a specific application.
func (*Client) CreateDeployment ¶
func (c *Client) CreateDeployment(ctx context.Context, params *CreateDeploymentInput, optFns ...func(*Options)) (*CreateDeploymentOutput, error)
Creates and starts a deployment to deploy an application into a runtime environment.
func (*Client) CreateEnvironment ¶
func (c *Client) CreateEnvironment(ctx context.Context, params *CreateEnvironmentInput, optFns ...func(*Options)) (*CreateEnvironmentOutput, error)
Creates a runtime environment for a given runtime engine.
func (*Client) DeleteApplication ¶
func (c *Client) DeleteApplication(ctx context.Context, params *DeleteApplicationInput, optFns ...func(*Options)) (*DeleteApplicationOutput, error)
Deletes a specific application. You cannot delete a running application.
func (*Client) DeleteApplicationFromEnvironment ¶
func (c *Client) DeleteApplicationFromEnvironment(ctx context.Context, params *DeleteApplicationFromEnvironmentInput, optFns ...func(*Options)) (*DeleteApplicationFromEnvironmentOutput, error)
Deletes a specific application from the specific runtime environment where it was previously deployed. You cannot delete a runtime environment using DeleteEnvironment if any application has ever been deployed to it. This API removes the association of the application with the runtime environment so you can delete the environment smoothly.
func (*Client) DeleteEnvironment ¶
func (c *Client) DeleteEnvironment(ctx context.Context, params *DeleteEnvironmentInput, optFns ...func(*Options)) (*DeleteEnvironmentOutput, error)
Deletes a specific runtime environment. The environment cannot contain deployed applications. If it does, you must delete those applications before you delete the environment.
func (*Client) GetApplication ¶
func (c *Client) GetApplication(ctx context.Context, params *GetApplicationInput, optFns ...func(*Options)) (*GetApplicationOutput, error)
Describes the details of a specific application.
func (*Client) GetApplicationVersion ¶
func (c *Client) GetApplicationVersion(ctx context.Context, params *GetApplicationVersionInput, optFns ...func(*Options)) (*GetApplicationVersionOutput, error)
Returns details about a specific version of a specific application.
func (*Client) GetBatchJobExecution ¶
func (c *Client) GetBatchJobExecution(ctx context.Context, params *GetBatchJobExecutionInput, optFns ...func(*Options)) (*GetBatchJobExecutionOutput, error)
Gets the details of a specific batch job execution for a specific application.
func (*Client) GetDataSetDetails ¶
func (c *Client) GetDataSetDetails(ctx context.Context, params *GetDataSetDetailsInput, optFns ...func(*Options)) (*GetDataSetDetailsOutput, error)
Gets the details of a specific data set.
func (*Client) GetDataSetImportTask ¶
func (c *Client) GetDataSetImportTask(ctx context.Context, params *GetDataSetImportTaskInput, optFns ...func(*Options)) (*GetDataSetImportTaskOutput, error)
Gets the status of a data set import task initiated with the CreateDataSetImportTask operation.
func (*Client) GetDeployment ¶
func (c *Client) GetDeployment(ctx context.Context, params *GetDeploymentInput, optFns ...func(*Options)) (*GetDeploymentOutput, error)
Gets details of a specific deployment with a given deployment identifier.
func (*Client) GetEnvironment ¶
func (c *Client) GetEnvironment(ctx context.Context, params *GetEnvironmentInput, optFns ...func(*Options)) (*GetEnvironmentOutput, error)
Describes a specific runtime environment.
func (*Client) GetSignedBluinsightsUrl ¶ added in v1.6.0
func (c *Client) GetSignedBluinsightsUrl(ctx context.Context, params *GetSignedBluinsightsUrlInput, optFns ...func(*Options)) (*GetSignedBluinsightsUrlOutput, error)
Gets a single sign-on URL that can be used to connect to AWS Blu Insights.
func (*Client) ListApplicationVersions ¶
func (c *Client) ListApplicationVersions(ctx context.Context, params *ListApplicationVersionsInput, optFns ...func(*Options)) (*ListApplicationVersionsOutput, error)
Returns a list of the application versions for a specific application.
func (*Client) ListApplications ¶
func (c *Client) ListApplications(ctx context.Context, params *ListApplicationsInput, optFns ...func(*Options)) (*ListApplicationsOutput, error)
Lists the applications associated with a specific Amazon Web Services account. You can provide the unique identifier of a specific runtime environment in a query parameter to see all applications associated with that environment.
func (*Client) ListBatchJobDefinitions ¶
func (c *Client) ListBatchJobDefinitions(ctx context.Context, params *ListBatchJobDefinitionsInput, optFns ...func(*Options)) (*ListBatchJobDefinitionsOutput, error)
Lists all the available batch job definitions based on the batch job resources uploaded during the application creation. You can use the batch job definitions in the list to start a batch job.
func (*Client) ListBatchJobExecutions ¶
func (c *Client) ListBatchJobExecutions(ctx context.Context, params *ListBatchJobExecutionsInput, optFns ...func(*Options)) (*ListBatchJobExecutionsOutput, error)
Lists historical, current, and scheduled batch job executions for a specific application.
func (*Client) ListBatchJobRestartPoints ¶ added in v1.13.0
func (c *Client) ListBatchJobRestartPoints(ctx context.Context, params *ListBatchJobRestartPointsInput, optFns ...func(*Options)) (*ListBatchJobRestartPointsOutput, error)
Lists all the job steps for JCL files to restart a batch job. This is only applicable for Micro Focus engine with versions 8.0.6 and above.
func (*Client) ListDataSetImportHistory ¶
func (c *Client) ListDataSetImportHistory(ctx context.Context, params *ListDataSetImportHistoryInput, optFns ...func(*Options)) (*ListDataSetImportHistoryOutput, error)
Lists the data set imports for the specified application.
func (*Client) ListDataSets ¶
func (c *Client) ListDataSets(ctx context.Context, params *ListDataSetsInput, optFns ...func(*Options)) (*ListDataSetsOutput, error)
Lists the data sets imported for a specific application. In Amazon Web Services Mainframe Modernization, data sets are associated with applications deployed on runtime environments. This is known as importing data sets. Currently, Amazon Web Services Mainframe Modernization can import data sets into catalogs using CreateDataSetImportTask.
func (*Client) ListDeployments ¶
func (c *Client) ListDeployments(ctx context.Context, params *ListDeploymentsInput, optFns ...func(*Options)) (*ListDeploymentsOutput, error)
Returns a list of all deployments of a specific application. A deployment is a combination of a specific application and a specific version of that application. Each deployment is mapped to a particular application version.
func (*Client) ListEngineVersions ¶
func (c *Client) ListEngineVersions(ctx context.Context, params *ListEngineVersionsInput, optFns ...func(*Options)) (*ListEngineVersionsOutput, error)
Lists the available engine versions.
func (*Client) ListEnvironments ¶
func (c *Client) ListEnvironments(ctx context.Context, params *ListEnvironmentsInput, optFns ...func(*Options)) (*ListEnvironmentsOutput, error)
Lists the runtime environments.
func (*Client) ListTagsForResource ¶
func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)
Lists the tags for the specified resource.
func (*Client) Options ¶ added in v1.10.0
Options returns a copy of the client configuration.
Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.
func (*Client) StartApplication ¶
func (c *Client) StartApplication(ctx context.Context, params *StartApplicationInput, optFns ...func(*Options)) (*StartApplicationOutput, error)
Starts an application that is currently stopped.
func (*Client) StartBatchJob ¶
func (c *Client) StartBatchJob(ctx context.Context, params *StartBatchJobInput, optFns ...func(*Options)) (*StartBatchJobOutput, error)
Starts a batch job and returns the unique identifier of this execution of the batch job. The associated application must be running in order to start the batch job.
func (*Client) StopApplication ¶
func (c *Client) StopApplication(ctx context.Context, params *StopApplicationInput, optFns ...func(*Options)) (*StopApplicationOutput, error)
Stops a running application.
func (*Client) TagResource ¶
func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
Adds one or more tags to the specified resource.
func (*Client) UntagResource ¶
func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
Removes one or more tags from the specified resource.
func (*Client) UpdateApplication ¶
func (c *Client) UpdateApplication(ctx context.Context, params *UpdateApplicationInput, optFns ...func(*Options)) (*UpdateApplicationOutput, error)
Updates an application and creates a new version.
func (*Client) UpdateEnvironment ¶
func (c *Client) UpdateEnvironment(ctx context.Context, params *UpdateEnvironmentInput, optFns ...func(*Options)) (*UpdateEnvironmentOutput, error)
Updates the configuration details for a specific runtime environment.
type CreateApplicationInput ¶
type CreateApplicationInput struct { // The application definition for this application. You can specify either inline // JSON or an S3 bucket location. // // This member is required. Definition types.Definition // The type of the target platform for this application. // // This member is required. EngineType types.EngineType // The unique identifier of the application. // // This member is required. Name *string // Unique, case-sensitive identifier the service generates to ensure the // idempotency of the request to create an application. The service generates the // clientToken when the API call is triggered. The token expires after one hour, so // if you retry the API within this timeframe with the same clientToken, you will // get the same response. The service also handles deleting the clientToken after // it expires. ClientToken *string // The description of the application. Description *string // The identifier of a customer managed key. KmsKeyId *string // The Amazon Resource Name (ARN) that identifies a role that the application uses // to access Amazon Web Services resources that are not part of the application or // are in a different Amazon Web Services account. RoleArn *string // A list of tags to apply to the application. Tags map[string]string // contains filtered or unexported fields }
type CreateApplicationOutput ¶
type CreateApplicationOutput struct { // The Amazon Resource Name (ARN) of the application. // // This member is required. ApplicationArn *string // The unique application identifier. // // This member is required. ApplicationId *string // The version number of the application. // // This member is required. ApplicationVersion *int32 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateDataSetImportTaskInput ¶
type CreateDataSetImportTaskInput struct { // The unique identifier of the application for which you want to import data sets. // // This member is required. ApplicationId *string // The data set import task configuration. // // This member is required. ImportConfig types.DataSetImportConfig // Unique, case-sensitive identifier you provide to ensure the idempotency of the // request to create a data set import. The service generates the clientToken when // the API call is triggered. The token expires after one hour, so if you retry the // API within this timeframe with the same clientToken, you will get the same // response. The service also handles deleting the clientToken after it expires. ClientToken *string // contains filtered or unexported fields }
type CreateDataSetImportTaskOutput ¶
type CreateDataSetImportTaskOutput struct { // The task identifier. This operation is asynchronous. Use this identifier with // the GetDataSetImportTaskoperation to obtain the status of this task. // // This member is required. TaskId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateDeploymentInput ¶
type CreateDeploymentInput struct { // The application identifier. // // This member is required. ApplicationId *string // The version of the application to deploy. // // This member is required. ApplicationVersion *int32 // The identifier of the runtime environment where you want to deploy this // application. // // This member is required. EnvironmentId *string // Unique, case-sensitive identifier you provide to ensure the idempotency of the // request to create a deployment. The service generates the clientToken when the // API call is triggered. The token expires after one hour, so if you retry the API // within this timeframe with the same clientToken, you will get the same response. // The service also handles deleting the clientToken after it expires. ClientToken *string // contains filtered or unexported fields }
type CreateDeploymentOutput ¶
type CreateDeploymentOutput struct { // The unique identifier of the deployment. // // This member is required. DeploymentId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateEnvironmentInput ¶
type CreateEnvironmentInput struct { // The engine type for the runtime environment. // // This member is required. EngineType types.EngineType // The type of instance for the runtime environment. // // This member is required. InstanceType *string // The name of the runtime environment. Must be unique within the account. // // This member is required. Name *string // Unique, case-sensitive identifier you provide to ensure the idempotency of the // request to create an environment. The service generates the clientToken when the // API call is triggered. The token expires after one hour, so if you retry the API // within this timeframe with the same clientToken, you will get the same response. // The service also handles deleting the clientToken after it expires. ClientToken *string // The description of the runtime environment. Description *string // The version of the engine type for the runtime environment. EngineVersion *string // The details of a high availability configuration for this runtime environment. HighAvailabilityConfig *types.HighAvailabilityConfig // The identifier of a customer managed key. KmsKeyId *string // Configures the maintenance window that you want for the runtime environment. // The maintenance window must have the format ddd:hh24:mi-ddd:hh24:mi and must be // less than 24 hours. The following two examples are valid maintenance windows: // sun:23:45-mon:00:15 or sat:01:00-sat:03:00 . // // If you do not provide a value, a random system-generated value will be assigned. PreferredMaintenanceWindow *string // Specifies whether the runtime environment is publicly accessible. PubliclyAccessible bool // The list of security groups for the VPC associated with this runtime // environment. SecurityGroupIds []string // Optional. The storage configurations for this runtime environment. StorageConfigurations []types.StorageConfiguration // The list of subnets associated with the VPC for this runtime environment. SubnetIds []string // The tags for the runtime environment. Tags map[string]string // contains filtered or unexported fields }
type CreateEnvironmentOutput ¶
type CreateEnvironmentOutput struct { // The unique identifier of the runtime environment. // // This member is required. EnvironmentId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteApplicationFromEnvironmentInput ¶
type DeleteApplicationFromEnvironmentInput struct { // The unique identifier of the application you want to delete. // // This member is required. ApplicationId *string // The unique identifier of the runtime environment where the application was // previously deployed. // // This member is required. EnvironmentId *string // contains filtered or unexported fields }
type DeleteApplicationFromEnvironmentOutput ¶
type DeleteApplicationFromEnvironmentOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteApplicationInput ¶
type DeleteApplicationInput struct { // The unique identifier of the application you want to delete. // // This member is required. ApplicationId *string // contains filtered or unexported fields }
type DeleteApplicationOutput ¶
type DeleteApplicationOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteEnvironmentInput ¶
type DeleteEnvironmentInput struct { // The unique identifier of the runtime environment you want to delete. // // This member is required. EnvironmentId *string // contains filtered or unexported fields }
type DeleteEnvironmentOutput ¶
type DeleteEnvironmentOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type EndpointParameters ¶ added in v1.7.0
type EndpointParameters struct { // The AWS region used to dispatch the request. // // Parameter is // required. // // AWS::Region Region *string // When true, use the dual-stack endpoint. If the configured endpoint does not // support dual-stack, dispatching the request MAY return an error. // // Defaults to // false if no value is provided. // // AWS::UseDualStack UseDualStack *bool // When true, send this request to the FIPS-compliant regional endpoint. If the // configured endpoint does not have a FIPS compliant endpoint, dispatching the // request will return an error. // // Defaults to false if no value is // provided. // // AWS::UseFIPS UseFIPS *bool // Override the endpoint used to send this request // // Parameter is // required. // // SDK::Endpoint Endpoint *string }
EndpointParameters provides the parameters that influence how endpoints are resolved.
func (EndpointParameters) ValidateRequired ¶ added in v1.7.0
func (p EndpointParameters) ValidateRequired() error
ValidateRequired validates required parameters are set.
func (EndpointParameters) WithDefaults ¶ added in v1.7.0
func (p EndpointParameters) WithDefaults() EndpointParameters
WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.
type EndpointResolver ¶
type EndpointResolver interface {
ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}
EndpointResolver interface for resolving service endpoints.
func EndpointResolverFromURL ¶
func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver
EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.
type EndpointResolverFunc ¶
type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)
EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.
func (EndpointResolverFunc) ResolveEndpoint ¶
func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)
type EndpointResolverOptions ¶
type EndpointResolverOptions = internalendpoints.Options
EndpointResolverOptions is the service endpoint resolver options
type EndpointResolverV2 ¶ added in v1.7.0
type EndpointResolverV2 interface { // ResolveEndpoint attempts to resolve the endpoint with the provided options, // returning the endpoint if found. Otherwise an error is returned. ResolveEndpoint(ctx context.Context, params EndpointParameters) ( smithyendpoints.Endpoint, error, ) }
EndpointResolverV2 provides the interface for resolving service endpoints.
func NewDefaultEndpointResolverV2 ¶ added in v1.7.0
func NewDefaultEndpointResolverV2() EndpointResolverV2
type GetApplicationInput ¶
type GetApplicationInput struct { // The identifier of the application. // // This member is required. ApplicationId *string // contains filtered or unexported fields }
type GetApplicationOutput ¶
type GetApplicationOutput struct { // The Amazon Resource Name (ARN) of the application. // // This member is required. ApplicationArn *string // The identifier of the application. // // This member is required. ApplicationId *string // The timestamp when this application was created. // // This member is required. CreationTime *time.Time // The type of the target platform for the application. // // This member is required. EngineType types.EngineType // The latest version of the application. // // This member is required. LatestVersion *types.ApplicationVersionSummary // The unique identifier of the application. // // This member is required. Name *string // The status of the application. // // This member is required. Status types.ApplicationLifecycle // The version of the application that is deployed. DeployedVersion *types.DeployedVersionSummary // The description of the application. Description *string // The identifier of the runtime environment where you want to deploy the // application. EnvironmentId *string // The identifier of a customer managed key. KmsKeyId *string // The timestamp when you last started the application. Null until the application // runs for the first time. LastStartTime *time.Time // The Amazon Resource Name (ARN) for the network load balancer listener created // in your Amazon Web Services account. Amazon Web Services Mainframe Modernization // creates this listener for you the first time you deploy an application. ListenerArns []string // The port associated with the network load balancer listener created in your // Amazon Web Services account. ListenerPorts []int32 // The public DNS name of the load balancer created in your Amazon Web Services // account. LoadBalancerDnsName *string // The list of log summaries. Each log summary includes the log type as well as // the log group identifier. These are CloudWatch logs. Amazon Web Services // Mainframe Modernization pushes the application log to CloudWatch under the // customer's account. LogGroups []types.LogGroupSummary // The Amazon Resource Name (ARN) of the role associated with the application. RoleArn *string // The reason for the reported status. StatusReason *string // A list of tags associated with the application. Tags map[string]string // Returns the Amazon Resource Names (ARNs) of the target groups that are attached // to the network load balancer. TargetGroupArns []string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetApplicationVersionOutput ¶
type GetApplicationVersionOutput struct { // The specific version of the application. // // This member is required. ApplicationVersion *int32 // The timestamp when the application version was created. // // This member is required. CreationTime *time.Time // The content of the application definition. This is a JSON object that contains // the resource configuration and definitions that identify an application. // // This member is required. DefinitionContent *string // The name of the application version. // // This member is required. Name *string // The status of the application version. // // This member is required. Status types.ApplicationVersionLifecycle // The application description. Description *string // The reason for the reported status. StatusReason *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetBatchJobExecutionOutput ¶
type GetBatchJobExecutionOutput struct { // The identifier of the application. // // This member is required. ApplicationId *string // The unique identifier for this batch job execution. // // This member is required. ExecutionId *string // The timestamp when the batch job execution started. // // This member is required. StartTime *time.Time // The status of the batch job execution. // // This member is required. Status types.BatchJobExecutionStatus // The unique identifier of this batch job. BatchJobIdentifier types.BatchJobIdentifier // The timestamp when the batch job execution ended. EndTime *time.Time // The unique identifier for this batch job. JobId *string // The name of this batch job. JobName *string // The restart steps information for the most recent restart operation. JobStepRestartMarker *types.JobStepRestartMarker // The type of job. JobType types.BatchJobType // The user for the job. JobUser *string // The batch job return code from either the Blu Age or Micro Focus runtime // engines. For more information, see [Batch return codes]in the IBM WebSphere Application Server // documentation. // // [Batch return codes]: https://www.ibm.com/docs/en/was/8.5.5?topic=model-batch-return-codes ReturnCode *string // The reason for the reported status. StatusReason *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetDataSetDetailsInput ¶
type GetDataSetDetailsOutput ¶
type GetDataSetDetailsOutput struct { // The name of the data set. // // This member is required. DataSetName *string // The size of the block on disk. Blocksize *int32 // The timestamp when the data set was created. CreationTime *time.Time // The type of data set. The only supported value is VSAM. DataSetOrg types.DatasetDetailOrgAttributes // File size of the dataset. FileSize *int64 // The last time the data set was referenced. LastReferencedTime *time.Time // The last time the data set was updated. LastUpdatedTime *time.Time // The location where the data set is stored. Location *string // The length of records in the data set. RecordLength *int32 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetDataSetImportTaskOutput ¶
type GetDataSetImportTaskOutput struct { // The status of the task. // // This member is required. Status types.DataSetTaskLifecycle // The task identifier. // // This member is required. TaskId *string // A summary of the status of the task. Summary *types.DataSetImportSummary // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetDeploymentInput ¶
type GetDeploymentOutput ¶
type GetDeploymentOutput struct { // The unique identifier of the application. // // This member is required. ApplicationId *string // The application version. // // This member is required. ApplicationVersion *int32 // The timestamp when the deployment was created. // // This member is required. CreationTime *time.Time // The unique identifier of the deployment. // // This member is required. DeploymentId *string // The unique identifier of the runtime environment. // // This member is required. EnvironmentId *string // The status of the deployment. // // This member is required. Status types.DeploymentLifecycle // The reason for the reported status. StatusReason *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetEnvironmentInput ¶
type GetEnvironmentInput struct { // The unique identifier of the runtime environment. // // This member is required. EnvironmentId *string // contains filtered or unexported fields }
type GetEnvironmentOutput ¶
type GetEnvironmentOutput struct { // The timestamp when the runtime environment was created. // // This member is required. CreationTime *time.Time // The target platform for the runtime environment. // // This member is required. EngineType types.EngineType // The version of the runtime engine. // // This member is required. EngineVersion *string // The Amazon Resource Name (ARN) of the runtime environment. // // This member is required. EnvironmentArn *string // The unique identifier of the runtime environment. // // This member is required. EnvironmentId *string // The type of instance underlying the runtime environment. // // This member is required. InstanceType *string // The name of the runtime environment. Must be unique within the account. // // This member is required. Name *string // The unique identifiers of the security groups assigned to this runtime // environment. // // This member is required. SecurityGroupIds []string // The status of the runtime environment. // // This member is required. Status types.EnvironmentLifecycle // The unique identifiers of the subnets assigned to this runtime environment. // // This member is required. SubnetIds []string // The unique identifier for the VPC used with this runtime environment. // // This member is required. VpcId *string // The number of instances included in the runtime environment. A standalone // runtime environment has a maximum of one instance. Currently, a high // availability runtime environment has a maximum of two instances. ActualCapacity *int32 // The description of the runtime environment. Description *string // The desired capacity of the high availability configuration for the runtime // environment. HighAvailabilityConfig *types.HighAvailabilityConfig // The identifier of a customer managed key. KmsKeyId *string // The Amazon Resource Name (ARN) for the load balancer used with the runtime // environment. LoadBalancerArn *string // Indicates the pending maintenance scheduled on this environment. PendingMaintenance *types.PendingMaintenance // The maintenance window for the runtime environment. If you don't provide a // value for the maintenance window, the service assigns a random value. PreferredMaintenanceWindow *string // Whether applications running in this runtime environment are publicly // accessible. PubliclyAccessible bool // The reason for the reported status. StatusReason *string // The storage configurations defined for the runtime environment. StorageConfigurations []types.StorageConfiguration // The tags defined for this runtime environment. Tags map[string]string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetSignedBluinsightsUrlInput ¶ added in v1.6.0
type GetSignedBluinsightsUrlInput struct {
// contains filtered or unexported fields
}
type GetSignedBluinsightsUrlOutput ¶ added in v1.6.0
type GetSignedBluinsightsUrlOutput struct { // Single sign-on AWS Blu Insights URL. // // This member is required. SignedBiUrl *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type HTTPSignerV4 ¶
type IdempotencyTokenProvider ¶
IdempotencyTokenProvider interface for providing idempotency token
type ListApplicationVersionsAPIClient ¶
type ListApplicationVersionsAPIClient interface {
ListApplicationVersions(context.Context, *ListApplicationVersionsInput, ...func(*Options)) (*ListApplicationVersionsOutput, error)
}
ListApplicationVersionsAPIClient is a client that implements the ListApplicationVersions operation.
type ListApplicationVersionsInput ¶
type ListApplicationVersionsInput struct { // The unique identifier of the application. // // This member is required. ApplicationId *string // The maximum number of application versions to return. MaxResults *int32 // A pagination token returned from a previous call to this operation. This // specifies the next item to return. To return to the beginning of the list, // exclude this parameter. NextToken *string // contains filtered or unexported fields }
type ListApplicationVersionsOutput ¶
type ListApplicationVersionsOutput struct { // The list of application versions. // // This member is required. ApplicationVersions []types.ApplicationVersionSummary // If there are more items to return, this contains a token that is passed to a // subsequent call to this operation to retrieve the next set of items. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListApplicationVersionsPaginator ¶
type ListApplicationVersionsPaginator struct {
// contains filtered or unexported fields
}
ListApplicationVersionsPaginator is a paginator for ListApplicationVersions
func NewListApplicationVersionsPaginator ¶
func NewListApplicationVersionsPaginator(client ListApplicationVersionsAPIClient, params *ListApplicationVersionsInput, optFns ...func(*ListApplicationVersionsPaginatorOptions)) *ListApplicationVersionsPaginator
NewListApplicationVersionsPaginator returns a new ListApplicationVersionsPaginator
func (*ListApplicationVersionsPaginator) HasMorePages ¶
func (p *ListApplicationVersionsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListApplicationVersionsPaginator) NextPage ¶
func (p *ListApplicationVersionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListApplicationVersionsOutput, error)
NextPage retrieves the next ListApplicationVersions page.
type ListApplicationVersionsPaginatorOptions ¶
type ListApplicationVersionsPaginatorOptions struct { // The maximum number of application versions to return. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListApplicationVersionsPaginatorOptions is the paginator options for ListApplicationVersions
type ListApplicationsAPIClient ¶
type ListApplicationsAPIClient interface {
ListApplications(context.Context, *ListApplicationsInput, ...func(*Options)) (*ListApplicationsOutput, error)
}
ListApplicationsAPIClient is a client that implements the ListApplications operation.
type ListApplicationsInput ¶
type ListApplicationsInput struct { // The unique identifier of the runtime environment where the applications are // deployed. EnvironmentId *string // The maximum number of applications to return. MaxResults *int32 // The names of the applications. Names []string // A pagination token to control the number of applications displayed in the list. NextToken *string // contains filtered or unexported fields }
type ListApplicationsOutput ¶
type ListApplicationsOutput struct { // Returns a list of summary details for all the applications in a runtime // environment. // // This member is required. Applications []types.ApplicationSummary // A pagination token that's returned when the response doesn't contain all // applications. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListApplicationsPaginator ¶
type ListApplicationsPaginator struct {
// contains filtered or unexported fields
}
ListApplicationsPaginator is a paginator for ListApplications
func NewListApplicationsPaginator ¶
func NewListApplicationsPaginator(client ListApplicationsAPIClient, params *ListApplicationsInput, optFns ...func(*ListApplicationsPaginatorOptions)) *ListApplicationsPaginator
NewListApplicationsPaginator returns a new ListApplicationsPaginator
func (*ListApplicationsPaginator) HasMorePages ¶
func (p *ListApplicationsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListApplicationsPaginator) NextPage ¶
func (p *ListApplicationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListApplicationsOutput, error)
NextPage retrieves the next ListApplications page.
type ListApplicationsPaginatorOptions ¶
type ListApplicationsPaginatorOptions struct { // The maximum number of applications to return. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListApplicationsPaginatorOptions is the paginator options for ListApplications
type ListBatchJobDefinitionsAPIClient ¶
type ListBatchJobDefinitionsAPIClient interface {
ListBatchJobDefinitions(context.Context, *ListBatchJobDefinitionsInput, ...func(*Options)) (*ListBatchJobDefinitionsOutput, error)
}
ListBatchJobDefinitionsAPIClient is a client that implements the ListBatchJobDefinitions operation.
type ListBatchJobDefinitionsInput ¶
type ListBatchJobDefinitionsInput struct { // The identifier of the application. // // This member is required. ApplicationId *string // The maximum number of batch job definitions to return. MaxResults *int32 // A pagination token returned from a previous call to this operation. This // specifies the next item to return. To return to the beginning of the list, // exclude this parameter. NextToken *string // If the batch job definition is a FileBatchJobDefinition, the prefix allows you // to search on the file names of FileBatchJobDefinitions. Prefix *string // contains filtered or unexported fields }
type ListBatchJobDefinitionsOutput ¶
type ListBatchJobDefinitionsOutput struct { // The list of batch job definitions. // // This member is required. BatchJobDefinitions []types.BatchJobDefinition // If there are more items to return, this contains a token that is passed to a // subsequent call to this operation to retrieve the next set of items. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListBatchJobDefinitionsPaginator ¶
type ListBatchJobDefinitionsPaginator struct {
// contains filtered or unexported fields
}
ListBatchJobDefinitionsPaginator is a paginator for ListBatchJobDefinitions
func NewListBatchJobDefinitionsPaginator ¶
func NewListBatchJobDefinitionsPaginator(client ListBatchJobDefinitionsAPIClient, params *ListBatchJobDefinitionsInput, optFns ...func(*ListBatchJobDefinitionsPaginatorOptions)) *ListBatchJobDefinitionsPaginator
NewListBatchJobDefinitionsPaginator returns a new ListBatchJobDefinitionsPaginator
func (*ListBatchJobDefinitionsPaginator) HasMorePages ¶
func (p *ListBatchJobDefinitionsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListBatchJobDefinitionsPaginator) NextPage ¶
func (p *ListBatchJobDefinitionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListBatchJobDefinitionsOutput, error)
NextPage retrieves the next ListBatchJobDefinitions page.
type ListBatchJobDefinitionsPaginatorOptions ¶
type ListBatchJobDefinitionsPaginatorOptions struct { // The maximum number of batch job definitions to return. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListBatchJobDefinitionsPaginatorOptions is the paginator options for ListBatchJobDefinitions
type ListBatchJobExecutionsAPIClient ¶
type ListBatchJobExecutionsAPIClient interface {
ListBatchJobExecutions(context.Context, *ListBatchJobExecutionsInput, ...func(*Options)) (*ListBatchJobExecutionsOutput, error)
}
ListBatchJobExecutionsAPIClient is a client that implements the ListBatchJobExecutions operation.
type ListBatchJobExecutionsInput ¶
type ListBatchJobExecutionsInput struct { // The unique identifier of the application. // // This member is required. ApplicationId *string // The unique identifier of each batch job execution. ExecutionIds []string // The name of each batch job execution. JobName *string // The maximum number of batch job executions to return. MaxResults *int32 // A pagination token to control the number of batch job executions displayed in // the list. NextToken *string // The time after which the batch job executions started. StartedAfter *time.Time // The time before the batch job executions started. StartedBefore *time.Time // The status of the batch job executions. Status types.BatchJobExecutionStatus // contains filtered or unexported fields }
type ListBatchJobExecutionsOutput ¶
type ListBatchJobExecutionsOutput struct { // Returns a list of batch job executions for an application. // // This member is required. BatchJobExecutions []types.BatchJobExecutionSummary // A pagination token that's returned when the response doesn't contain all batch // job executions. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListBatchJobExecutionsPaginator ¶
type ListBatchJobExecutionsPaginator struct {
// contains filtered or unexported fields
}
ListBatchJobExecutionsPaginator is a paginator for ListBatchJobExecutions
func NewListBatchJobExecutionsPaginator ¶
func NewListBatchJobExecutionsPaginator(client ListBatchJobExecutionsAPIClient, params *ListBatchJobExecutionsInput, optFns ...func(*ListBatchJobExecutionsPaginatorOptions)) *ListBatchJobExecutionsPaginator
NewListBatchJobExecutionsPaginator returns a new ListBatchJobExecutionsPaginator
func (*ListBatchJobExecutionsPaginator) HasMorePages ¶
func (p *ListBatchJobExecutionsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListBatchJobExecutionsPaginator) NextPage ¶
func (p *ListBatchJobExecutionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListBatchJobExecutionsOutput, error)
NextPage retrieves the next ListBatchJobExecutions page.
type ListBatchJobExecutionsPaginatorOptions ¶
type ListBatchJobExecutionsPaginatorOptions struct { // The maximum number of batch job executions to return. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListBatchJobExecutionsPaginatorOptions is the paginator options for ListBatchJobExecutions
type ListBatchJobRestartPointsInput ¶ added in v1.13.0
type ListBatchJobRestartPointsOutput ¶ added in v1.13.0
type ListBatchJobRestartPointsOutput struct { // Returns all the batch job steps and related information for a batch job that // previously ran. BatchJobSteps []types.JobStep // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListDataSetImportHistoryAPIClient ¶
type ListDataSetImportHistoryAPIClient interface {
ListDataSetImportHistory(context.Context, *ListDataSetImportHistoryInput, ...func(*Options)) (*ListDataSetImportHistoryOutput, error)
}
ListDataSetImportHistoryAPIClient is a client that implements the ListDataSetImportHistory operation.
type ListDataSetImportHistoryInput ¶
type ListDataSetImportHistoryInput struct { // The unique identifier of the application. // // This member is required. ApplicationId *string // The maximum number of objects to return. MaxResults *int32 // A pagination token returned from a previous call to this operation. This // specifies the next item to return. To return to the beginning of the list, // exclude this parameter. NextToken *string // contains filtered or unexported fields }
type ListDataSetImportHistoryOutput ¶
type ListDataSetImportHistoryOutput struct { // The data set import tasks. // // This member is required. DataSetImportTasks []types.DataSetImportTask // If there are more items to return, this contains a token that is passed to a // subsequent call to this operation to retrieve the next set of items. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListDataSetImportHistoryPaginator ¶
type ListDataSetImportHistoryPaginator struct {
// contains filtered or unexported fields
}
ListDataSetImportHistoryPaginator is a paginator for ListDataSetImportHistory
func NewListDataSetImportHistoryPaginator ¶
func NewListDataSetImportHistoryPaginator(client ListDataSetImportHistoryAPIClient, params *ListDataSetImportHistoryInput, optFns ...func(*ListDataSetImportHistoryPaginatorOptions)) *ListDataSetImportHistoryPaginator
NewListDataSetImportHistoryPaginator returns a new ListDataSetImportHistoryPaginator
func (*ListDataSetImportHistoryPaginator) HasMorePages ¶
func (p *ListDataSetImportHistoryPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListDataSetImportHistoryPaginator) NextPage ¶
func (p *ListDataSetImportHistoryPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDataSetImportHistoryOutput, error)
NextPage retrieves the next ListDataSetImportHistory page.
type ListDataSetImportHistoryPaginatorOptions ¶
type ListDataSetImportHistoryPaginatorOptions struct { // The maximum number of objects to return. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListDataSetImportHistoryPaginatorOptions is the paginator options for ListDataSetImportHistory
type ListDataSetsAPIClient ¶
type ListDataSetsAPIClient interface {
ListDataSets(context.Context, *ListDataSetsInput, ...func(*Options)) (*ListDataSetsOutput, error)
}
ListDataSetsAPIClient is a client that implements the ListDataSets operation.
type ListDataSetsInput ¶
type ListDataSetsInput struct { // The unique identifier of the application for which you want to list the // associated data sets. // // This member is required. ApplicationId *string // The maximum number of objects to return. MaxResults *int32 // Filter dataset name matching the specified pattern. Can use * and % as wild // cards. NameFilter *string // A pagination token returned from a previous call to this operation. This // specifies the next item to return. To return to the beginning of the list, // exclude this parameter. NextToken *string // The prefix of the data set name, which you can use to filter the list of data // sets. Prefix *string // contains filtered or unexported fields }
type ListDataSetsOutput ¶
type ListDataSetsOutput struct { // The list of data sets, containing information including the creation time, the // data set name, the data set organization, the data set format, and the last time // the data set was referenced or updated. // // This member is required. DataSets []types.DataSetSummary // If there are more items to return, this contains a token that is passed to a // subsequent call to this operation to retrieve the next set of items. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListDataSetsPaginator ¶
type ListDataSetsPaginator struct {
// contains filtered or unexported fields
}
ListDataSetsPaginator is a paginator for ListDataSets
func NewListDataSetsPaginator ¶
func NewListDataSetsPaginator(client ListDataSetsAPIClient, params *ListDataSetsInput, optFns ...func(*ListDataSetsPaginatorOptions)) *ListDataSetsPaginator
NewListDataSetsPaginator returns a new ListDataSetsPaginator
func (*ListDataSetsPaginator) HasMorePages ¶
func (p *ListDataSetsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListDataSetsPaginator) NextPage ¶
func (p *ListDataSetsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDataSetsOutput, error)
NextPage retrieves the next ListDataSets page.
type ListDataSetsPaginatorOptions ¶
type ListDataSetsPaginatorOptions struct { // The maximum number of objects to return. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListDataSetsPaginatorOptions is the paginator options for ListDataSets
type ListDeploymentsAPIClient ¶
type ListDeploymentsAPIClient interface {
ListDeployments(context.Context, *ListDeploymentsInput, ...func(*Options)) (*ListDeploymentsOutput, error)
}
ListDeploymentsAPIClient is a client that implements the ListDeployments operation.
type ListDeploymentsInput ¶
type ListDeploymentsInput struct { // The application identifier. // // This member is required. ApplicationId *string // The maximum number of objects to return. MaxResults *int32 // A pagination token returned from a previous call to this operation. This // specifies the next item to return. To return to the beginning of the list, // exclude this parameter. NextToken *string // contains filtered or unexported fields }
type ListDeploymentsOutput ¶
type ListDeploymentsOutput struct { // The list of deployments that is returned. // // This member is required. Deployments []types.DeploymentSummary // If there are more items to return, this contains a token that is passed to a // subsequent call to this operation to retrieve the next set of items. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListDeploymentsPaginator ¶
type ListDeploymentsPaginator struct {
// contains filtered or unexported fields
}
ListDeploymentsPaginator is a paginator for ListDeployments
func NewListDeploymentsPaginator ¶
func NewListDeploymentsPaginator(client ListDeploymentsAPIClient, params *ListDeploymentsInput, optFns ...func(*ListDeploymentsPaginatorOptions)) *ListDeploymentsPaginator
NewListDeploymentsPaginator returns a new ListDeploymentsPaginator
func (*ListDeploymentsPaginator) HasMorePages ¶
func (p *ListDeploymentsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListDeploymentsPaginator) NextPage ¶
func (p *ListDeploymentsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDeploymentsOutput, error)
NextPage retrieves the next ListDeployments page.
type ListDeploymentsPaginatorOptions ¶
type ListDeploymentsPaginatorOptions struct { // The maximum number of objects to return. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListDeploymentsPaginatorOptions is the paginator options for ListDeployments
type ListEngineVersionsAPIClient ¶
type ListEngineVersionsAPIClient interface {
ListEngineVersions(context.Context, *ListEngineVersionsInput, ...func(*Options)) (*ListEngineVersionsOutput, error)
}
ListEngineVersionsAPIClient is a client that implements the ListEngineVersions operation.
type ListEngineVersionsInput ¶
type ListEngineVersionsInput struct { // The type of target platform. EngineType types.EngineType // The maximum number of objects to return. MaxResults *int32 // A pagination token returned from a previous call to this operation. This // specifies the next item to return. To return to the beginning of the list, // exclude this parameter. NextToken *string // contains filtered or unexported fields }
type ListEngineVersionsOutput ¶
type ListEngineVersionsOutput struct { // Returns the engine versions. // // This member is required. EngineVersions []types.EngineVersionsSummary // If there are more items to return, this contains a token that is passed to a // subsequent call to this operation to retrieve the next set of items. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListEngineVersionsPaginator ¶
type ListEngineVersionsPaginator struct {
// contains filtered or unexported fields
}
ListEngineVersionsPaginator is a paginator for ListEngineVersions
func NewListEngineVersionsPaginator ¶
func NewListEngineVersionsPaginator(client ListEngineVersionsAPIClient, params *ListEngineVersionsInput, optFns ...func(*ListEngineVersionsPaginatorOptions)) *ListEngineVersionsPaginator
NewListEngineVersionsPaginator returns a new ListEngineVersionsPaginator
func (*ListEngineVersionsPaginator) HasMorePages ¶
func (p *ListEngineVersionsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListEngineVersionsPaginator) NextPage ¶
func (p *ListEngineVersionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListEngineVersionsOutput, error)
NextPage retrieves the next ListEngineVersions page.
type ListEngineVersionsPaginatorOptions ¶
type ListEngineVersionsPaginatorOptions struct { // The maximum number of objects to return. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListEngineVersionsPaginatorOptions is the paginator options for ListEngineVersions
type ListEnvironmentsAPIClient ¶
type ListEnvironmentsAPIClient interface {
ListEnvironments(context.Context, *ListEnvironmentsInput, ...func(*Options)) (*ListEnvironmentsOutput, error)
}
ListEnvironmentsAPIClient is a client that implements the ListEnvironments operation.
type ListEnvironmentsInput ¶
type ListEnvironmentsInput struct { // The engine type for the runtime environment. EngineType types.EngineType // The maximum number of runtime environments to return. MaxResults *int32 // The names of the runtime environments. Must be unique within the account. Names []string // A pagination token to control the number of runtime environments displayed in // the list. NextToken *string // contains filtered or unexported fields }
type ListEnvironmentsOutput ¶
type ListEnvironmentsOutput struct { // Returns a list of summary details for all the runtime environments in your // account. // // This member is required. Environments []types.EnvironmentSummary // A pagination token that's returned when the response doesn't contain all the // runtime environments. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListEnvironmentsPaginator ¶
type ListEnvironmentsPaginator struct {
// contains filtered or unexported fields
}
ListEnvironmentsPaginator is a paginator for ListEnvironments
func NewListEnvironmentsPaginator ¶
func NewListEnvironmentsPaginator(client ListEnvironmentsAPIClient, params *ListEnvironmentsInput, optFns ...func(*ListEnvironmentsPaginatorOptions)) *ListEnvironmentsPaginator
NewListEnvironmentsPaginator returns a new ListEnvironmentsPaginator
func (*ListEnvironmentsPaginator) HasMorePages ¶
func (p *ListEnvironmentsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListEnvironmentsPaginator) NextPage ¶
func (p *ListEnvironmentsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListEnvironmentsOutput, error)
NextPage retrieves the next ListEnvironments page.
type ListEnvironmentsPaginatorOptions ¶
type ListEnvironmentsPaginatorOptions struct { // The maximum number of runtime environments to return. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListEnvironmentsPaginatorOptions is the paginator options for ListEnvironments
type ListTagsForResourceInput ¶
type ListTagsForResourceInput struct { // The Amazon Resource Name (ARN) of the resource. // // This member is required. ResourceArn *string // contains filtered or unexported fields }
type ListTagsForResourceOutput ¶
type ListTagsForResourceOutput struct { // The tags for the resource. // // This member is required. Tags map[string]string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type Options ¶
type Options struct { // Set of options to modify how an operation is invoked. These apply to all // operations invoked for this client. Use functional options on operation call to // modify this list for per operation behavior. APIOptions []func(*middleware.Stack) error // The optional application specific identifier appended to the User-Agent header. AppID string // This endpoint will be given as input to an EndpointResolverV2. It is used for // providing a custom base endpoint that is subject to modifications by the // processing EndpointResolverV2. BaseEndpoint *string // Configures the events that will be sent to the configured logger. ClientLogMode aws.ClientLogMode // The credentials object to use when signing requests. Credentials aws.CredentialsProvider // The configuration DefaultsMode that the SDK should use when constructing the // clients initial default settings. DefaultsMode aws.DefaultsMode // The endpoint options to be used when attempting to resolve an endpoint. EndpointOptions EndpointResolverOptions // The service endpoint resolver. // // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and // BaseEndpoint. // // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be // used over the deprecated EndpointResolver. EndpointResolverV2 EndpointResolverV2 // Signature Version 4 (SigV4) Signer HTTPSignerV4 HTTPSignerV4 // Provides idempotency tokens values that will be automatically populated into // idempotent API operations. IdempotencyTokenProvider IdempotencyTokenProvider // The logger writer interface to write logging messages to. Logger logging.Logger // The client meter provider. MeterProvider metrics.MeterProvider // The region to send requests to. (Required) Region string // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify // per operation call's retry max attempts. // // If specified in an operation call's functional options with a value that is // different than the constructed client's Options, the Client's Retryer will be // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if // Retryer option is not also specified. // // When creating a new API Clients this member will only be used if the Retryer // Options member is nil. This value will be ignored if Retryer is not nil. // // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable // failures. When nil the API client will use a default retryer. The kind of // default retry created by the API client can be changed with the RetryMode // option. Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment // The client tracer provider. TracerProvider tracing.TracerProvider // The HTTP client to invoke API calls with. Defaults to client's default HTTP // implementation if nil. HTTPClient HTTPClient // The auth scheme resolver which determines how to authenticate for each // operation. AuthSchemeResolver AuthSchemeResolver // The list of auth schemes supported by the client. AuthSchemes []smithyhttp.AuthScheme // contains filtered or unexported fields }
func (Options) GetIdentityResolver ¶ added in v1.9.2
func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver
type ResolveEndpoint ¶
type ResolveEndpoint struct { Resolver EndpointResolver Options EndpointResolverOptions }
func (*ResolveEndpoint) HandleSerialize ¶
func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, )
func (*ResolveEndpoint) ID ¶
func (*ResolveEndpoint) ID() string
type StartApplicationInput ¶
type StartApplicationInput struct { // The unique identifier of the application you want to start. // // This member is required. ApplicationId *string // contains filtered or unexported fields }
type StartApplicationOutput ¶
type StartApplicationOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type StartBatchJobInput ¶
type StartBatchJobInput struct { // The unique identifier of the application associated with this batch job. // // This member is required. ApplicationId *string // The unique identifier of the batch job. // // This member is required. BatchJobIdentifier types.BatchJobIdentifier // The collection of batch job parameters. For details about limits for keys and // values, see [Coding variables in JCL]. // // [Coding variables in JCL]: https://www.ibm.com/docs/en/workload-automation/9.3.0?topic=zos-coding-variables-in-jcl JobParams map[string]string // contains filtered or unexported fields }
type StartBatchJobOutput ¶
type StartBatchJobOutput struct { // The unique identifier of this execution of the batch job. // // This member is required. ExecutionId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type StopApplicationInput ¶
type StopApplicationInput struct { // The unique identifier of the application you want to stop. // // This member is required. ApplicationId *string // Stopping an application process can take a long time. Setting this parameter to // true lets you force stop the application so you don't need to wait until the // process finishes to apply another action on the application. The default value // is false. ForceStop bool // contains filtered or unexported fields }
type StopApplicationOutput ¶
type StopApplicationOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type TagResourceInput ¶
type TagResourceOutput ¶
type TagResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UntagResourceInput ¶
type UntagResourceOutput ¶
type UntagResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateApplicationInput ¶
type UpdateApplicationInput struct { // The unique identifier of the application you want to update. // // This member is required. ApplicationId *string // The current version of the application to update. // // This member is required. CurrentApplicationVersion *int32 // The application definition for this application. You can specify either inline // JSON or an S3 bucket location. Definition types.Definition // The description of the application to update. Description *string // contains filtered or unexported fields }
type UpdateApplicationOutput ¶
type UpdateApplicationOutput struct { // The new version of the application. // // This member is required. ApplicationVersion *int32 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateEnvironmentInput ¶
type UpdateEnvironmentInput struct { // The unique identifier of the runtime environment that you want to update. // // This member is required. EnvironmentId *string // Indicates whether to update the runtime environment during the maintenance // window. The default is false. Currently, Amazon Web Services Mainframe // Modernization accepts the engineVersion parameter only if // applyDuringMaintenanceWindow is true. If any parameter other than engineVersion // is provided in UpdateEnvironmentRequest , it will fail if // applyDuringMaintenanceWindow is set to true. ApplyDuringMaintenanceWindow bool // The desired capacity for the runtime environment to update. The minimum // possible value is 0 and the maximum is 100. DesiredCapacity *int32 // The version of the runtime engine for the runtime environment. EngineVersion *string // Forces the updates on the environment. This option is needed if the // applications in the environment are not stopped or if there are ongoing // application-related activities in the environment. // // If you use this option, be aware that it could lead to data corruption in the // applications, and that you might need to perform repair and recovery procedures // for the applications. // // This option is not needed if the attribute being updated is // preferredMaintenanceWindow . ForceUpdate bool // The instance type for the runtime environment to update. InstanceType *string // Configures the maintenance window that you want for the runtime environment. // The maintenance window must have the format ddd:hh24:mi-ddd:hh24:mi and must be // less than 24 hours. The following two examples are valid maintenance windows: // sun:23:45-mon:00:15 or sat:01:00-sat:03:00 . // // If you do not provide a value, a random system-generated value will be assigned. PreferredMaintenanceWindow *string // contains filtered or unexported fields }
type UpdateEnvironmentOutput ¶
type UpdateEnvironmentOutput struct { // The unique identifier of the runtime environment that was updated. // // This member is required. EnvironmentId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Source Files ¶
- api_client.go
- api_op_CancelBatchJobExecution.go
- api_op_CreateApplication.go
- api_op_CreateDataSetImportTask.go
- api_op_CreateDeployment.go
- api_op_CreateEnvironment.go
- api_op_DeleteApplication.go
- api_op_DeleteApplicationFromEnvironment.go
- api_op_DeleteEnvironment.go
- api_op_GetApplication.go
- api_op_GetApplicationVersion.go
- api_op_GetBatchJobExecution.go
- api_op_GetDataSetDetails.go
- api_op_GetDataSetImportTask.go
- api_op_GetDeployment.go
- api_op_GetEnvironment.go
- api_op_GetSignedBluinsightsUrl.go
- api_op_ListApplicationVersions.go
- api_op_ListApplications.go
- api_op_ListBatchJobDefinitions.go
- api_op_ListBatchJobExecutions.go
- api_op_ListBatchJobRestartPoints.go
- api_op_ListDataSetImportHistory.go
- api_op_ListDataSets.go
- api_op_ListDeployments.go
- api_op_ListEngineVersions.go
- api_op_ListEnvironments.go
- api_op_ListTagsForResource.go
- api_op_StartApplication.go
- api_op_StartBatchJob.go
- api_op_StopApplication.go
- api_op_TagResource.go
- api_op_UntagResource.go
- api_op_UpdateApplication.go
- api_op_UpdateEnvironment.go
- auth.go
- deserializers.go
- doc.go
- endpoints.go
- go_module_metadata.go
- options.go
- serializers.go
- validators.go